diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index 32f4fb4a..c6805879 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -47,8 +47,8 @@ The regular expressions are basic case-insensitive PCRE, see {{{man-link(pcre,3) * CFIND OPTIONS -** --format=plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv -sets the output format to the given value. The following are available: +** --format plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv +Sets the output format to the given value. The following are available: #+ATTR_MAN: :disable-caption t | --format= | description | @@ -68,13 +68,14 @@ any double-quote is replaced by a double-double quote (thus, "hello" become ""hello"", and fields with commas are put in double-quotes. Normally, this should only apply to name fields. -** --personal,-p only show addresses seen in messages where one of `my' e-mail +** -p, --personal +Only show addresses seen in messages where one of `my' e-mail addresses was seen in one of the address fields; this is to exclude addresses only seen in mailing-list messages. See the *--my-address* parameter to *mu init*. -** --after= only show addresses last seen after -==. == is a UNIX *time_t* value, the number of -seconds since 1970-01-01 (in UTC). +** --after _timestamp_ +Only show addresses last seen after _timestamp_. _timestamp_ is a UNIX +*time_t* value, the number of seconds since 1970-01-01 (in UTC). From the command line, you can use the *date* command to get this value. For example, only consider addresses last seen after 2020-06-01, you could specify diff --git a/man/mu-extract.1.org b/man/mu-extract.1.org index 97613785..96a131e7 100644 --- a/man/mu-extract.1.org +++ b/man/mu-extract.1.org @@ -32,37 +32,36 @@ the message. Only `leaf' MIME-parts (including RFC822 attachments) are considered, *multipart/** etc. are ignored. Without a filename parameter, *mu extract* reads a message from standard-input. In -that case, you cannot use the second, ~~ parameter as this would be +that case, you cannot use the second, _PATTERN_ parameter as this would be ambiguous; instead, use the *--matches* option. * EXTRACT OPTIONS ** -a, --save-attachments -save all MIME-parts that look like attachments. +Save all MIME-parts that look like attachments. ** --save-all -save all non-multipart MIME-parts. +Save all non-multipart MIME-parts. -** --parts= -only consider the following numbered parts (comma-separated list). The numbers +** --parts _parts_ +Only consider the following numbered _parts_ (comma-separated list). The numbers for the parts can be seen from running *mu extract* without any options but only the message file. -** --target-dir= -save the parts in the target directory rather than the current working -directory. +** --target-dir _dir_ +Save the parts in _dir_ rather than the current working directory. ** --overwrite -overwrite existing files with the same name; by default overwriting is not +Overwrite existing files with the same name; by default overwriting is not allowed. ** -u,--uncooked -by default, *mu* transforms the attachment filenames a bit (such as by replacing +By default, *mu* transforms the attachment filenames a bit (such as by replacing spaces by dashes); with this option, leave that to the minimum for creating a legal filename in the target directory. -** --matches= -Attachments with filenames matching the pattern will be extracted. The regular +** --matches _pattern_ +Attachments with filenames matching _pattern_ will be extracted. The regular expressions are basic PCRE, and are case-sensitive by default; see {{{man-link(pcre,3)}}} for more details. diff --git a/man/mu-find.1.org b/man/mu-find.1.org index 576e640d..83e15e46 100644 --- a/man/mu-find.1.org +++ b/man/mu-find.1.org @@ -45,15 +45,15 @@ For details on the possible queries, see {{{man-link(mu-query,7)}}}. * FIND OPTIONS -Note, some of the important options are described in the {{{man-link(mu*,1)}}} +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. 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"*, *--sortfield=date* and *--reverse*. -** -f, --fields= -specifies a string that determines which fields are shown in the output. This +** -f, --fields _fields_ +Specifies a string that determines which fields are shown in the output. This string consists of a number of characters (such as 's' for subject or 'f' for from), which will replace with the actual field in the output. Fields that are not known will be output as-is, allowing for some simple formatting. @@ -86,8 +86,8 @@ The message flags are described in {{{man-link(mu-query,7)}}}. As an example, a message which is `seen', has an attachment and is signed would have `asz' as its corresponding output string, while an encrypted new message would have `nx'. -** -s, --sortfield= and -z,--reverse -specify the field to sort the search results by and the direction (i.e., +** -s, --sortfield _field_ and -z,--reverse +Specify the field to sort the search results by and the direction (i.e., `reverse' means that the sort should be reverted - Z-A). Examples include: #+begin_example @@ -113,16 +113,16 @@ Note, if you specify a sortfield, by default, messages are sorted in reverse (descending) order (e.g., from lowest to highest). This is usually a good choice, but for dates it may be more useful to sort in the opposite direction. -** -n, --maxnum= -If > 0, display maximally that number of entries. If not specified, all matching -entries are displayed. +** -n, --maxnum _number_ +If _number_ > 0, display maximally that number of entries. If not specified, all +matching entries are displayed. -** --summary-len= -If > 0, use that number of lines of the message to provide a summary. +** --summary-len _number_ +If _number_ > 0, use that number of lines of the message to provide a summary. -** --format= +** --format plain|links|xml|sexp -output results in the specified format: +Output results in the specified format. - The default is *plain*, i.e normal output with one line per message. - *links* outputs the results as a maildir with symbolic links to the found @@ -130,10 +130,10 @@ output results in the specified format: information). - *xml* formats the search results as XML. - *sexp* formats the search results as an s-expression as used in Lisp programming - environments + environments. -** --linksdir= and -c, --clearlinks -when using *-format=links*, output the results as a maildir with symbolic links to +** --linksdir _dir_ and -c, --clearlinks +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 below for more information). *mu* will create the maildir if it does not exist yet. @@ -150,9 +150,9 @@ exist yet, it will be created. Note: when *mu* creates a Maildir for these links it automatically inserts a _.noindex_ file, to exclude the directory from *mu index*. -** --after= -only show messages whose message files were last modified (*mtime*) after -==. == is a UNIX *time_t* value, the number of seconds since +** --after _timestamp_ +Only show messages whose message files were last modified (*mtime*) after +_timestamp_. _timestamp_ is a UNIX *time_t* value, the number of seconds since 1970-01-01 (in UTC). From the command line, you can use the *date* command to get this value. For @@ -163,8 +163,8 @@ could specify #+end_example This is assuming the GNU *date* command. -** --exec= -the *--exec* coption causes the =command= to be executed on each matched message; +** --exec _command_ +The *--exec* coption causes _command_ to be executed on each matched message; for example, to see the raw text of all messages matching `milkshake', you could use: #+begin_example @@ -175,24 +175,23 @@ which is roughly equivalent to: $ mu find milkshake --fields="l" | xargs less #+end_example -** -b, --bookmark= -use a bookmarked search query. Using this option, a query from your bookmark +** -b, --bookmark _bookmark_ +Use a bookmarked search query. Using this option, a query from your bookmark file will be prepended to other search queries. See {{{man-link(mu-bookmarks,5)}}} for the details of the bookmarks file. - ** -u, --skip-dups -whenever there are multiple messages with the same message-id field, only show +Whenever there are multiple messages with the same message-id field, only show the first one. This is useful if you have copies of the same message, which is a common occurrence when using e.g. Gmail together with *offlineimap*. ** -r, --include-related -include messages being referred to by the matched messages -- i.e.. include +Include messages being referred to by the matched messages -- i.e.. include messages that are part of the same message thread as some matched messages. This is useful if you want Gmail-style `conversations'. ** -t, --threads -show messages in a `threaded' format -- that is, with indentation and arrows +Show messages in a `threaded' format -- that is, with indentation and arrows showing the conversation threads in the list of matching messages. When using this, sorting is chronological (by date), based on the newest message in a thread. @@ -215,7 +214,7 @@ The algorithm used for determining the threads is based on Jamie Zawinksi's description: http://www.jwz.org/doc/threading.html ** -a,--analyze -instead of executing the query, analyze it by show the parse-tree s-expression +Instead of executing the query, analyze it by show the parse-tree s-expression and a stringified version of the Xapian query. This can help users to determine how *mu* interprets some query. diff --git a/man/mu-index.1.org b/man/mu-index.1.org index 5794ffc6..5ddb35b7 100644 --- a/man/mu-index.1.org +++ b/man/mu-index.1.org @@ -66,8 +66,7 @@ terminate immediately. * INDEX OPTIONS ** --lazy-check - -in lazy-check mode, *mu* does not consider messages for which the time-stamp +In lazy-check mode, *mu* does not consider messages for which the time-stamp (ctime) of the directory they reside in has not changed since the previous indexing run. This is much faster than the non-lazy check, but won't update messages that have change (rather than having been added or removed), since @@ -76,12 +75,10 @@ you can run *mu-index* occasionally without *--lazy-check*, to pick up such messages. ** --nocleanup - -disable the database cleanup that *mu* does by default after indexing. +Disable the database cleanup that *mu* does by default after indexing. ** --reindex - -perform a complete reindexing of all the messages in the maildir. +Perform a complete reindexing of all the messages in the maildir. #+include: "muhome.inc" :minlevel 2 diff --git a/man/mu-init.1.org b/man/mu-init.1.org index 0850a6dd..21e46e8a 100644 --- a/man/mu-init.1.org +++ b/man/mu-init.1.org @@ -17,60 +17,53 @@ has completed, you can run *mu index* * INIT OPTIONS -** -m, --maildir= - -use == as the root-maildir. +** -m, --maildir _maildir_ +Use _maildir_ as the root-maildir. By default, *mu* uses the *MAILDIR* environment; if it is not set, it uses _~/Maildir_ if it is an existing directory. If neither of those can be used, the *--maildir* option is required; it must be an absolute path (but ~~/~ expansion is performed). -** --my-address= - -specifies that some e-mail address is `my-address' (the option can be used +** --my-address _email-address-or-regex_ +Specifies that some e-mail address is `my-address' (the option can be used multiple times). Any message in which at least one of the contact fields contains such an address is considered a `personal' messages; this can then be used for filtering in {{{man-link(mu-find,1)}}}, {{{man-link(mu-cfind,1)}}} and *mu4e*, e.g. to filter-out mailing list messages. -== can be either a plain e-mail address (such as +_email-address-or-regex_ can be either a plain e-mail address (such as *foo@example.com*), or a basic PCRE regular-expression (see {{{man-link(pcre,3)}}} for details), wrapped in */* (such as =/foo-.*@example\\.com/=). Depending on your shell, the argument may need to be quoted. -** --ignored-address= - -specifies that some e-mail address is to be ignored from the contacts-cache (the +** --ignored-address _email-address-or-regex_ +Specifies that some e-mail address is to be ignored from the contacts-cache (the option can be used multiple times). Such addresses then cannot be found with {{{man-link(mu-cfind,1)}}} or in the Mu4e contacts cache. -== can be either a plain e-mail address or a regexp, just like +_my-email-address_ can be either a plain e-mail address or a regexp, just like for the *--my-address* option. -** --max-message-size= - -specifies the maximum size for an e-mail message. Usually, the default of +** --max-message-size _size_ +Specifies the maximum size for an e-mail message. Usually, the default of 100000000 bytes should be fine. -** --batch-size= - -the number of changes after which they are committed to the database; decreasing +** --batch-size _size_ +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 substantially slower. Usually, the default of 250000 should be fine. Batch-size 0 is interpreted as `use the default'. ** --support-ngrams - -whether to enable support for using ngrams in indexing and query parsing; this +Whether to enable support for using ngrams in indexing and query parsing; this can be useful for languages without explicit word breaks, such as Chinese/Japanese/Korean. See *NGRAM SUPPORT* below for details. ** --reinit - -reinitialize the database from an earlier version; that is, create a new empty +Reinitialize the database from an earlier version; that is, create a new empty database with the existing settings. This cannot be combined with the other *init* options. diff --git a/man/mu-mkdir.1.org b/man/mu-mkdir.1.org index c1587c3b..6d876098 100644 --- a/man/mu-mkdir.1.org +++ b/man/mu-mkdir.1.org @@ -23,8 +23,8 @@ were created. This is for safety reasons. * MKDIR OPTIONS -** --mode= -set the file access mode for the new maildir(s) as in +** --mode _mode_ +Set the file access mode for the new maildir(s) as in {{{man-link(chmod,1)}}}. The default is 0755. #+include: "common-options.inc" :minlevel 1 diff --git a/man/mu-move.1.org b/man/mu-move.1.org index c389c0d9..36b93d62 100644 --- a/man/mu-move.1.org +++ b/man/mu-move.1.org @@ -22,26 +22,22 @@ for *mu*'s database (see *mu info store*). * MOVE OPTIONS -** --flags= - -specify the new message flags. See *FLAGS* for details. +** --flags _flags_ +Specify the new message flags. See *FLAGS* for details. ** --change-name - -change the basename of the message file when moving; this can be useful when +Change the basename of the message file when moving; this can be useful when using some external tools such as {{{man-link(mbsync,1)}}} which otherwise get confused ** --update-dups - -update the flags of duplicate messages too, where "duplicate messages" are +Update the flags of duplicate messages too, where "duplicate messages" are defined as all message that share the same message-id. Note that the Draft/Flagged/Trashed flags are deliberately _not_ changed if you change those on the source message. -** --dry-run,-n - -print the target filename(s), but don't change anything. +** -n, --dry-run +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 use a dry-run to predict the exact name when doing a `real' run. diff --git a/man/mu-server.1.org b/man/mu-server.1.org index d003ae6e..cd401e0f 100644 --- a/man/mu-server.1.org +++ b/man/mu-server.1.org @@ -50,15 +50,12 @@ UTF-8 (in which the s-expressions are encoded). * SERVER OPTIONS ** --commands +List available commands (and try with *--verbose*). -List available commands (and try with *--verbose*) - -** --eval - -Evaluate a mu4e server s-expression +** --eval _expression_ +Evaluate a mu4e server s-expression. ** --allow-temp-file - If set, allow for the output of some commands to use temp-files rather than directly through the emacs process input/output. This is noticeably faster for commands with a lot of output, esp. when the the temp-file uses a in-memory diff --git a/man/mu-verify.1.org b/man/mu-verify.1.org index 93914353..e253ff07 100644 --- a/man/mu-verify.1.org +++ b/man/mu-verify.1.org @@ -22,11 +22,11 @@ standard-input. * VERIFY OPTIONS ** -r, --auto-retrieve -attempt to find keys online (see the *auto-key-retrieve* option in the +Attempt to find keys online (see the *auto-key-retrieve* option in the {{{man-link(gnupg,1)}}} documentation). -** decrypt -attempt to decrypt the message +** --decrypt +Attempt to decrypt the message. #+include: "common-options.inc" :minlevel 1 diff --git a/man/mu-view.1.org b/man/mu-view.1.org index 7dc20817..6f6a8ec5 100644 --- a/man/mu-view.1.org +++ b/man/mu-view.1.org @@ -24,27 +24,27 @@ standard-input. * VIEW OPTIONS -** --format,-o = -use the given output format, one of: +** -o, --format _format_ +Use the given output format, one of: -- *plain* - use the plain-text body; this is the default -- *html* - use the HTML body -- *sexp* - show the S-expression representation of the message +- *plain*: use the plain-text body; this is the default, +- *html*: use the HTML body, +- *sexp*: show the S-expression representation of the message. -** --summary-len= -instead of displaying the full message, output a summary based upon the first -== lines of the message. +** --summary-len _number_ +Instead of displaying the full message, output a summary based upon the first +_number_ lines of the message. ** --terminate -terminate messages with \\​f (=form-feed=) characters when displaying them. This is +Terminate messages with \\​f (=form-feed=) characters when displaying them. This is useful when you want to further process them. ** --decrypt -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. ** --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 diff --git a/man/muhome.inc b/man/muhome.inc index f3414c1b..237cef8e 100644 --- a/man/muhome.inc +++ b/man/muhome.inc @@ -1,5 +1,5 @@ ** --muhome -use a non-default directory to store and read the database, write the logs, etc. +Use a non-default directory to store and read the database, write the logs, etc. By default, *mu* uses the XDG Base Directory Specification (e.g. on GNU/Linux this defaults to _~/.cache/mu_ and _~/.config/mu_). Earlier versions of *mu* defaulted to _~/.mu_, which now requires *--muhome=~/.mu*.