man: fix typos / omissions

Update the man-pages for various small error / inconsistencies / typos
etc.
This commit is contained in:
Dirk-Jan C. Binnema
2026-07-26 11:37:08 +03:00
committed by Seth Ladygo
parent 6b1358ea48
commit 0b725f6c81
13 changed files with 71 additions and 41 deletions

View File

@ -11,8 +11,11 @@ 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.
** -v, --verbose
Causes *mu* to output extra information, for some commands.
** --log-stderr ** --log-stderr
Causes *mu* to not output log messages to standard error, in addition to sending Causes *mu* to output log messages to standard error, in addition to sending
them to the standard logging location. them to the standard logging location.
** --nocolor ** --nocolor

View File

@ -47,7 +47,7 @@ The regular expressions are basic case-insensitive PCRE, see {{{man-link(pcre,3)
* CFIND OPTIONS * CFIND OPTIONS
** --format plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv ** --format plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv|json
Sets the output format to the given value. The following are available: Sets the output format to the given value. The following are available:
#+ATTR_MAN: :disable-caption t #+ATTR_MAN: :disable-caption t
@ -84,6 +84,10 @@ example, only consider addresses last seen after 2020-06-01, you could specify
--after=$(date +%s --date='2020-06-01') --after=$(date +%s --date='2020-06-01')
#+end_example #+end_example
** -n, --maxnum _number_
If _number_ > 0, display maximally that number of contacts. If not specified,
all matching contacts are displayed.
#+include: "muhome.inc" :minlevel 2 #+include: "muhome.inc" :minlevel 2
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1

View File

@ -71,6 +71,13 @@ particular file type. On MacOS, this uses the *open* program, on other platforms
it uses *xdg-open*. You can choose a different program by setting the it uses *xdg-open*. You can choose a different program by setting the
*MU_PLAY_PROGRAM* environment variable. *MU_PLAY_PROGRAM* environment variable.
** --decrypt
Attempt to decrypt encrypted parts. This is only possible if *mu* was built with
crypto-support.
** -r, --auto-retrieve
Attempt to retrieve crypto-keys automatically from the network, when needed.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1
* EXAMPLES * EXAMPLES

View File

@ -49,8 +49,8 @@ Note, some of the important options are described in the {{{man-link(mu,1)}}}
manual page and not here, as they apply to multiple *mu* commands. manual page and not here, as they apply to multiple *mu* commands.
The *find*-command has various options that influence the way *mu* displays the The *find*-command has various options that influence the way *mu* displays the
results. If you don't specify anything, the defaults are *--fields="d f s"*, results. If you don't specify anything, the defaults are *--fields="d f s"* and
*--sortfield=date* and *--reverse*. *--sortfield=date*.
** -f, --fields _fields_ ** -f, --fields _fields_
Specifies a string that determines which fields are shown in the output. This Specifies a string that determines which fields are shown in the output. This
@ -103,15 +103,15 @@ Specify the field to sort the search results by and the direction (i.e.,
For the complete list, try the command: *mu info fields*. For the complete list, try the command: *mu info fields*.
Thus, for example, to sort messages by date, you could specify: Thus, for example, to sort messages by date, newest first, you could specify:
#+begin_example #+begin_example
$ mu find fahrrad --fields "d f s" --sortfield=date --reverse $ mu find fahrrad --fields "d f s" --sortfield=date --reverse
#+end_example #+end_example
Note, if you specify a sortfield, by default, messages are sorted in reverse Note, by default messages are sorted in ascending (A-Z) order; with *--reverse*
(descending) order (e.g., from lowest to highest). This is usually a good they are sorted in descending (Z-A) order — for dates, that means the newest
choice, but for dates it may be more useful to sort in the opposite direction. messages come first.
** -n, --maxnum _number_ ** -n, --maxnum _number_
@ -134,11 +134,11 @@ Output results in the specified format.
- *sexp* formats the search results as an s-expression as used in Lisp programming - *sexp* formats the search results as an s-expression as used in Lisp programming
environments. environments.
- *json* formats the output as JSON; it is a direct translation of the *sexp* format - *json* formats the output as JSON; it is a direct translation of the *sexp* format
- *json2* is a slightly more idiomatic JSON, for now the only difference with *json* - *json2* is a slightly more idiomatic JSON; for now the only difference with *json*
is that the latter avoids the ':' prefix in key-names (e.g., "subject" instead is that *json2* avoids the ':' prefix in key-names (e.g., "subject" instead
of ":subject"). *json2* is still experimental. of ":subject"). *json2* is still experimental.
** --linksdir _dir_ and -c, --clearlinks ** --linksdir _dir_ and --clearlinks
When using *--format=links*, output the results as a maildir with symbolic links When using *--format=links*, output the results as a maildir with symbolic links
to the found messages. This enables easy integration with mail-clients (see to the found messages. This enables easy integration with mail-clients (see
@ -160,12 +160,12 @@ index*.
** --after _timestamp_ ** --after _timestamp_
Only show messages whose message files were last modified (*mtime*) after Only show messages whose message files were last changed (*ctime*) after
_timestamp_. _timestamp_ is a UNIX *time_t* value, the number of seconds since _timestamp_. _timestamp_ is a UNIX *time_t* value, the number of seconds since
1970-01-01 (in UTC). 1970-01-01 (in UTC).
From the command line, you can use the *date* command to get this value. For From the command line, you can use the *date* command to get this value. For
example, only consider messages modified (or created) in the last 5 minutes, you example, only consider messages changed (or created) in the last 5 minutes, you
could specify could specify
#+begin_example #+begin_example
--after=`date +%s --date='5 min ago'` --after=`date +%s --date='5 min ago'`

View File

@ -56,7 +56,7 @@ much faster. See *PERFORMANCE (i,ii,iii)* below for more information.
The optional cleanup-phase of the indexing-process is the removal of messages The optional cleanup-phase of the indexing-process is the removal of messages
from the database for which there is no longer a corresponding file in the from the database for which there is no longer a corresponding file in the
Maildir. If you do not want this, you can use *-n*, *--nocleanup*. Maildir. If you do not want this, you can use *--nocleanup*.
When *mu index* catches one of the signals *SIGINT*, *SIGHUP* or *SIGTERM* (e.g., when When *mu index* catches one of the signals *SIGINT*, *SIGHUP* or *SIGTERM* (e.g., when
you press *Ctrl-C* during the indexing process), it attempts to shutdown you press *Ctrl-C* during the indexing process), it attempts to shutdown

View File

@ -22,6 +22,10 @@ mu-info - show information
Note that while running (e.g. ~mu4e~), some of the *store* information can be Note that while running (e.g. ~mu4e~), some of the *store* information can be
delayed due to database caching. delayed due to database caching.
* INFO OPTIONS
#+include: "muhome.inc" :minlevel 2
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1
#+include: "exit-code.inc" :minlevel 1 #+include: "exit-code.inc" :minlevel 1

View File

@ -40,7 +40,7 @@ for details), wrapped in */* (such as =/foo-.*@example\\.com/=). Depending on yo
shell, the argument may need to be quoted. shell, the argument may need to be quoted.
A note of warning for *mu4e* users: any regular-expressions used with A note of warning for *mu4e* users: any regular-expressions used with
=--with-address= are also used by *mu4e*. Unfortunately, PCRE regular expressions =--personal-address= are also used by *mu4e*. Unfortunately, PCRE regular expressions
are *not* generally compatible with Emacs regular expressions. For instance, are *not* generally compatible with Emacs regular expressions. For instance,
*(foo|bar)* in PCRE syntax has *\(foo\|bar\)* as its Emacs equivalent. *(foo|bar)* in PCRE syntax has *\(foo\|bar\)* as its Emacs equivalent.
@ -65,8 +65,8 @@ Specifies the maximum size for an e-mail message. Usually, the default of
** --batch-size _size_ ** --batch-size _size_
The number of changes after which they are committed to the database; decreasing The number of changes after which they are committed to the database; decreasing
the value reduces the memory requirements, at the cost of make indexing the value reduces the memory requirements, at the cost of making indexing
substantially slower. Usually, the default of 250000 should be fine. substantially slower. Usually, the default of 50000 should be fine.
Batch-size 0 is interpreted as `use the default'. Batch-size 0 is interpreted as `use the default'.
@ -100,7 +100,7 @@ variables such as *XAPIAN_CJK_NGRAM* are ignored.
* RESTORING LABELS * RESTORING LABELS
When you have any _labels_ defined for your database, *mu* automatically exports When you have any _labels_ defined for your database, *mu* automatically exports
those to a file in the *mu* cache directory; you see this in the ~--init~ output. those to a file in the *mu* cache directory; you see this in the ~--reinit~ output.
#+begin_example #+begin_example
$ mu init --reinit $ mu init --reinit
@ -109,7 +109,7 @@ exported labels to: /home/user/.cache/mu/mu-export-2025-08-16-13:43:27.txt
You can restore those labels _after_ re-indexing, e.g., You can restore those labels _after_ re-indexing, e.g.,
#+begin_example #+begin_example
$ mu label import /home/user/.cache/mu/mu-export-2025-08-16-13:43:27.txt $ mu labels import /home/user/.cache/mu/mu-export-2025-08-16-13:43:27.txt
#+end_example #+end_example
Please see {{{man-link(mu-labels,1)}}} for further details. Please see {{{man-link(mu-labels,1)}}} for further details.

View File

@ -12,7 +12,7 @@ mu-labels - attach labels to messages. Export labels to file, and import them.
*mu* [_COMMON-OPTIONS_] labels list *mu* [_COMMON-OPTIONS_] labels list
*mu* [_COMMON-OPTIONS_] labels list-restore *mu* [_COMMON-OPTIONS_] labels restore-list
*mu* [_COMMON-OPTIONS_] labels clear [CLEAR-OPTIONS] "<query>" *mu* [_COMMON-OPTIONS_] labels clear [CLEAR-OPTIONS] "<query>"
@ -31,9 +31,9 @@ A label is a string associated with a message.
- *update* for changing the labels for the messages matching some query - *update* for changing the labels for the messages matching some query
- *clear* for clearing all labels from messages matching some query - *clear* for clearing all labels from messages matching some query
- *list* to list all labels that are used in the store - *list* to list all labels that are used in the store
- *list-restore* to restore the list of labels from the database (store) - *restore-list* to restore the list of labels from the database (store)
- *export* to write the label information to a file - *export* to write the label information to a file
- *import* the read label information from a file - *import* to read label information from a file
*Important*: unlike other message metadata stored by *mu*, labels _cannot_ be restored *Important*: unlike other message metadata stored by *mu*, labels _cannot_ be restored
by merely re-indexing messages, since the information is not part of the message by merely re-indexing messages, since the information is not part of the message
@ -54,7 +54,7 @@ using from a shell.
*mu4e* users: note the difference, in *mu4e* the label expressions are *mu4e* users: note the difference, in *mu4e* the label expressions are
_space_-separated, here they are _comma_-separated. _space_-separated, here they are _comma_-separated.
** --dry-run ** -n, --dry-run
only print what /would/ change, but do not change anything only print what /would/ change, but do not change anything
@ -66,7 +66,7 @@ The *clear* command removes all labels from messages that match some query. As
with *update*, the query must be recognized as a single parameter, i.e., quote it with *update*, the query must be recognized as a single parameter, i.e., quote it
when using a shell. when using a shell.
** --dry-run ** -n, --dry-run
only print what /would/ change, but do not change anything only print what /would/ change, but do not change anything
@ -77,13 +77,13 @@ when using a shell.
The *list* command lists all the labels that are currently in use in the store. The *list* command lists all the labels that are currently in use in the store.
This is the information is used for auto-completion in *mu4e*. This is the information is used for auto-completion in *mu4e*.
With the (global, directly after *mu) *--verbose* option, this also includes the With the (global, directly after *mu*) *--verbose* option, this also includes the
counts. counts.
* LIST-RESTORE OPTIONS * RESTORE-LIST OPTIONS
It is possible that the list of labels (as per the *list* sub-command) gets It is possible that the list of labels (as per the *list* sub-command) gets
outdated for various reasons. With *list-restore*, this list get refreshed with outdated for various reasons. With *restore-list*, this list gets refreshed with
the actual labels as seen in the store. the actual labels as seen in the store.
* EXPORT OPTIONS * EXPORT OPTIONS
@ -109,7 +109,7 @@ The *import* command is for restoring the labels from a file created through
See *EXPORT FORMAT* below for details on the format. See *EXPORT FORMAT* below for details on the format.
** --dry-run ** -n, --dry-run
only print what would change, but do not change anything only print what would change, but do not change anything
@ -121,7 +121,7 @@ See *EXPORT FORMAT* below for details on the format.
restrictions on what is accepted as a label. restrictions on what is accepted as a label.
- a *valid label character* is any character that is not a control-character, not - a *valid label character* is any character that is not a control-character, not
a blank, nor anything matching the regular expression ~[^\"$',/\\`]~ a blank, nor anything matching the regular expression ~[\"$',/\\`]~
- a *valid label* consists of one or more valid label characters, the first of - a *valid label* consists of one or more valid label characters, the first of
which must *not* be either *+* or *-* which must *not* be either *+* or *-*
@ -186,5 +186,5 @@ $ mu labels clear "label:boring"
* SEE ALSO * SEE ALSO
{{{man-link(mu-query,1)}}}, {{{man-link(mu-query,7)}}},
{{{man-link(mu-find,1)}}}, {{{man-link(mu-find,1)}}}

View File

@ -42,6 +42,8 @@ Print the target filename(s), but don't change anything.
Note that with the *--change-name*, the target name is not constant, so you cannot Note that with the *--change-name*, the target name is not constant, so you cannot
use a dry-run to predict the exact name when doing a `real' run. use a dry-run to predict the exact name when doing a `real' run.
#+include: "muhome.inc" :minlevel 2
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1
* FLAGS * FLAGS
@ -109,6 +111,8 @@ $ mu move /home/user/Maildir/project1/cur/1695559560.a73985881f4611ac2.hostname!
#+include: "prefooter.inc" :minlevel 1 #+include: "prefooter.inc" :minlevel 1
#+include: "exit-code.inc" :minlevel 1
* SEE ALSO * SEE ALSO
{{{man-link(maildir,5)}}} {{{man-link(maildir,5)}}}

View File

@ -56,7 +56,7 @@ found 7173 match(es)
* ENVIRONMENT * ENVIRONMENT
By default, *mu scm* expects its internal files to be found in By default, *mu scm* expects its internal files to be found in
~<prefix>/hare/mu/scm~. However, for development/testing you can set the ~<prefix>/share/mu/scm~. However, for development/testing you can set the
environment variable *MU_SCM_DIR* to some alternative directory. environment variable *MU_SCM_DIR* to some alternative directory.
* SEE ALSO * SEE ALSO

View File

@ -63,7 +63,7 @@ file-system.
** --listen ** --listen
If set, the server starts an SCM REPL as well, which listens on a Unix domain If set, the server starts an SCM REPL as well, which listens on a Unix domain
socket. This corresponds to the *--listen* options for *mu scm**. socket. This corresponds to the *--listen* option for *mu scm*.
The store object (including the Xapian database) is shared between the server and the REPL. The store object (including the Xapian database) is shared between the server and the REPL.

View File

@ -43,7 +43,7 @@ useful when you want to further process them.
Attempt to decrypt encrypted message bodies. This is only possible if *mu* Attempt to decrypt encrypted message bodies. This is only possible if *mu*
was built with crypto-support. was built with crypto-support.
** --auto-retrieve ** -r, --auto-retrieve
Attempt to retrieve crypto-keys automatically from the network, when needed. Attempt to retrieve crypto-keys automatically from the network, when needed.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1

View File

@ -25,9 +25,13 @@ For information about the common options, see *COMMON OPTIONS*.
- *index*: (re)index the messages in a Maildir - *index*: (re)index the messages in a Maildir
- *info*: show information about the *mu* database - *info*: show information about the *mu* database
- *init*: initialize the *mu* database - *init*: initialize the *mu* database
- *labels*: manage message labels
- *mkdir*: create a new Maildir - *mkdir*: create a new Maildir
- *move*: move a message or change its flags
- *remove*: remove specific messages from the database - *remove*: remove specific messages from the database
- *scm*: start a Guile/Scheme shell or run a script
- *server*: start a server process (for ~mu4e~-internal use) - *server*: start a server process (for ~mu4e~-internal use)
- *verify*: verify cryptographic message signatures
- *view*: view a specific message - *view*: view a specific message
Each of the commands have their own manpage *mu-<command>*. Each of the commands have their own manpage *mu-<command>*.
@ -57,9 +61,9 @@ man-page as well.
Some *mu* commands support colorized output, and do so by default when writing to Some *mu* commands support colorized output, and do so by default when writing to
a TTY (roughly, to a screen). When not writing to a TTY, for instance when a TTY (roughly, to a screen). When not writing to a TTY, for instance when
redirection the output to a file or using a pipe, the default is to *not* show redirection the output to a file or using a pipe, the default is to *not* show
output. colors.
If you don no want colors, you can use *--nocolor*. If you do not want colors, you can use *--nocolor*.
If you want colors even when it is not the default, use *--nocolor=false*. If you want colors even when it is not the default, use *--nocolor=false*.
@ -81,15 +85,15 @@ the output is always UTF-8, regardless of the locale:
* DATABASE AND FILE * DATABASE AND FILE
The *index*, *find*, and *cfind* commands work with the database, while the other The *index*, *find*, *cfind*, *move*, *add*, *remove* and *labels* commands work with the
ones work on individual mail files. Hence, running *view*, *mkdir* and *extract* does database, while the other ones work on individual mail files. Hence, running
not require the *mu* database. *view*, *mkdir* and *extract* does not require the *mu* database.
* LOGGING * LOGGING
*mu* logs to the standard logging location, which is either the systemd journal, *mu* logs to the standard logging location, which is either the systemd journal,
*syslog* or a log file (by default, _~/.cache/mu/mu.log_), depending on your *syslog* or a log file (by default, _~/.cache/mu/mu.log_), depending on your
*system's setup; the first that appears to be working is used. system's setup; the first that appears to be working is used.
When using a log file, it can safely be deleted when *mu* is not running. When When using a log file, 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 running with *--debug* option, the log file can grow rather quickly. See the note
@ -112,9 +116,13 @@ on logging below.
{{{man-link(mu-index,1)}}}, {{{man-link(mu-index,1)}}},
{{{man-link(mu-info,1)}}}, {{{man-link(mu-info,1)}}},
{{{man-link(mu-init,1)}}}, {{{man-link(mu-init,1)}}},
{{{man-link(mu-labels,1)}}},
{{{man-link(mu-mkdir,1)}}}, {{{man-link(mu-mkdir,1)}}},
{{{man-link(mu-move,1)}}},
{{{man-link(mu-remove,1)}}}, {{{man-link(mu-remove,1)}}},
{{{man-link(mu-scm,1)}}},
{{{man-link(mu-server,1)}}}, {{{man-link(mu-server,1)}}},
{{{man-link(mu-verify,1)}}},
{{{man-link(mu-view,1)}}}, {{{man-link(mu-view,1)}}},
{{{man-link(mu-query,7)}}}, {{{man-link(mu-query,7)}}},
{{{man-link(mu-easy,1)}}} {{{man-link(mu-easy,7)}}}