mu-man: typeset option values differently

Use underlining only, do not use <>, as it is the most often done.

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
+** --format plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv
-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
 | --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=<timestamp> only show addresses last seen after
+** --after _timestamp_
-=<timestamp>=. =<timestamp>= is a UNIX *time_t* value, the number of
+Only show addresses last seen after _timestamp_. _timestamp_ is a UNIX
-seconds since 1970-01-01 (in UTC).
+*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

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, ~<pattern>~ 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=<parts>
+** --parts _parts_
-only consider the following numbered parts (comma-separated list). The numbers
+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=<dir>
+** --target-dir _dir_
-save the parts in the target directory rather than the current working
+Save the parts in _dir_ rather than the current working directory.
-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=<pattern>
+** --matches _pattern_
-Attachments with filenames matching the pattern will be extracted. The regular
+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.
 

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=<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
 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=<field> and -z,--reverse
+** -s, --sortfield _field_ and -z,--reverse
-specify the field to sort the search results by and the direction (i.e.,
+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=<number>
+** -n, --maxnum _number_
-If > 0, display maximally that number of entries. If not specified, all matching
+If _number_ > 0, display maximally that number of entries. If not specified, all
-entries are displayed.
+matching entries are displayed.
 
-** --summary-len=<number>
+** --summary-len _number_
-If > 0, use that number of lines of the message to provide a summary.
+If _number_ > 0, use that number of lines of the message to provide a summary.
 
-** --format=<plain|links|xml|sexp>
+** --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=<dir> and -c, --clearlinks
+** --linksdir _dir_ and -c, --clearlinks
-when using *-format=links*, output the results as a maildir with symbolic links to
+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=<timestamp>
+** --after _timestamp_
-only show messages whose message files were last modified (*mtime*) after
+Only show messages whose message files were last modified (*mtime*) 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).
 
 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=<command>
+** --exec _command_
-the *--exec* coption causes the =command= to be executed on each matched message;
+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=<bookmark>
+** -b, --bookmark _bookmark_
-use a bookmarked search query. Using this option, a query from your 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.
 

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
 

man/mu-init.1.org

@@ -17,60 +17,53 @@ has completed, you can run *mu index*
 
 * INIT OPTIONS
 
-** -m, --maildir=<maildir>
+** -m, --maildir _maildir_
-
+Use _maildir_ as the root-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=<email-address-or-regex>
+** --my-address _email-address-or-regex_
-
+Specifies that some e-mail address is `my-address' (the option can be used
-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.
 
-=<email-address-or-regex>= 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=<email-address-or-regex>
+** --ignored-address _email-address-or-regex_
-
+Specifies that some e-mail address is to be ignored from the contacts-cache (the
-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.
 
-=<my-email-address>= 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=<size>
+** --max-message-size _size_
-
+Specifies the maximum size for an e-mail message. Usually, the default of
-specifies the maximum size for an e-mail message. Usually, the default of
 100000000 bytes should be fine.
 
-** --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
 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.
 

man/mu-mkdir.1.org

@@ -23,8 +23,8 @@ were created. This is for safety reasons.
 
 * MKDIR OPTIONS
 
-** --mode=<mode>
+** --mode _mode_
-set the file access mode for the new maildir(s) as in
+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

man/mu-move.1.org

@@ -22,26 +22,22 @@ for *mu*'s database (see *mu info store*).
 
 * MOVE OPTIONS
 
-** --flags=<flags>
+** --flags _flags_
-
+Specify the new message flags. See *FLAGS* for details.
-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
+** -n, --dry-run
-
+Print the target filename(s), but don't change anything.
-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.

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 _expression_
-
+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

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
+** --decrypt
-attempt to decrypt the message
+Attempt to decrypt the message.
 
 #+include: "common-options.inc" :minlevel 1
 

man/mu-view.1.org

@@ -24,27 +24,27 @@ standard-input.
 
 * VIEW OPTIONS
 
-** --format,-o  = <format>
+** -o, --format _format_
-use the given output format, one of:
+Use the given output format, one of:
 
-- *plain* - use the plain-text body; this is the default
+- *plain*: use the plain-text body; this is the default,
-- *html* - use the HTML body
+- *html*: use the HTML body,
-- *sexp* - show the S-expression representation of the message
+- *sexp*: show the S-expression representation of the message.
 
-** --summary-len=<number>
+** --summary-len _number_
-instead of displaying the full message, output a summary based upon the first
+Instead of displaying the full message, output a summary based upon the first
-=<number>= lines of the message.
+_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
 

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*.