common-options: capitalize first sentences

This commit is contained in:
Tristan Riehs
2024-07-16 14:11:50 +09:00
parent f66a4a37f5
commit fab36e283a

View File

@ -1,30 +1,30 @@
* COMMON OPTIONS * COMMON OPTIONS
** -d, --debug ** -d, --debug
makes mu generate extra debug information, useful for debugging the program Makes mu generate extra debug information, useful for debugging the program
itself. By default, debug information goes to the log file, ~/.cache/mu/mu.log. itself. By default, debug information goes to the log file, _~/.cache/mu/mu.log_.
It can safely be deleted when mu is not running. When running with --debug It can safely be deleted when mu is not running. When running with *--debug*
option, the log file can grow rather quickly. See the note on logging below. option, the log file can grow rather quickly. See the note on logging below.
** -q, --quiet ** -q, --quiet
causes mu not to output informational messages and progress information to Causes mu not to output informational messages and progress information to
standard output, but only to the log file. Error messages will still be sent to standard output, but only to the log file. Error messages will still be sent to
standard error. Note that mu index is much faster with --quiet, so it is standard error. Note that *mu index* is much faster with *--quiet*, so it is
recommended you use this option when using mu from scripts etc. recommended you use this option when using mu from scripts etc.
** --log-stderr ** --log-stderr
causes mu to not output log messages to standard error, in addition to sending Causes mu to not output log messages to standard error, in addition to sending
them to the log file. them to the log file.
** --nocolor ** --nocolor
do not use ANSI colors. The environment variable ~NO_COLOR~ can be used as an Do not use ANSI colors. The environment variable *NO_COLOR* can be used as an
alternative to ~--nocolor~. alternative to *--nocolor*.
** -V, --version ** -V, --version
prints mu version and copyright information. Prints *mu* version and copyright information.
** -h, --help ** -h, --help
lists the various command line options. Lists the various command line options.
# Local Variables: # Local Variables:
# mode: org # mode: org