3:15 p.m.
this would be my OCD coming through, but as i'm crawling through the
man page markdown files, i see a lack of consistency in how various
objects are marked (and therefore possibly rendered).
using podman-run.1.md as a single example, it first appears that
commands are marked with double asterisks, as in:
"Run a process in a new container. **podman run** starts a process
with its own file system, its own networking, and its own isolated
process tree. The IMAGE which starts the process may define defaults
related to the process that will be run in the container, the
networking to expose, and more, but **podman run** ..."
ok, fair enough, so that's the standard for commands which, in a
simple terminal window, renders as bold.
on the other hand, filenames apparently use backqoutes:
"Several files will be automatically created within the container.
These include `/etc/hosts`, `/etc/hostname`, and `/etc/resolv.conf` to
manage networking..."
again, fair enough, except in the very next para, they're not
similarly marked:
"When running from a user defined network namespace, the
/etc/netns/NSNAME/resolv.conf will be used if it exists, otherwise
/etc/resolv.conf will be used..."
in any event, that is also rendered as bold in a terminal window, so
i'm assuming that, in other environments, there will be a difference
in rendering.
next, WRT options, i notice that some man pages use the word
"option" while others use the word "flag". from the same markdown
file
we're using so far, we have both examples:
"Add a line to /etc/hosts. The format is hostname:ip. The
**--add-host** option can be set multiple times."
"To modify the proportion from the default of 1024, use the
**--cpu-shares** flag to set the weighting to 2 or higher."
is it worth bouncing back and forth between "flag" and "option"?
finally, in other pages, there is the occasional example of a flag
that doesn't include the leading two hyphens, such as near the
beginning of podman-save.1.md:
"**podman save** writes to STDOUT by default and can be redirected to
a file using the **output** flag. The **quiet** flag suppresses the
output when set."
i'm guessing that the above should read **--output** and
**--quiet**, no?
in any event, is there a short list of standards for all of this?
rday