Merge pull request #2652 from a3a3el/more-man-page-fixes

More man page fixes

man/meson.build

@@ -55,6 +55,7 @@ man_orgs=[
   'mu-info.1.org',
   'mu-init.1.org',
   'mu-mkdir.1.org',
+  'mu-move.1.org',
   'mu-query.7.org',
   'mu-remove.1.org',
   'mu-server.1.org',
@@ -81,6 +82,7 @@ foreach src : man_orgs
   expr_tmpl = ''.join([
     '(progn',
     '  (require \'ox-man)',
+    '  (setq org-export-with-sub-superscripts \'{})',
     '  (org-export-to-file \'man "@0@"))'])
   expr = expr_tmpl.format(org.substring(0,-4))
   sectiondir = join_paths(mandir, 'man' + section)

man/mu-add.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-~mu add~ - add one or more messages to the database
+mu-add - add one or more messages to the database
 
 * SYNOPSIS
 

man/mu-bookmarks.5.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-bookmarks - file with bookmarks (shortcuts) for mu search expressions
+mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions
 
 * DESCRIPTION
 

man/mu-cfind.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu cfind* is the *mu* command to find contacts in the *mu* database and export them
+mu-cfind - find contacts in the *mu* database and export them
 for use in other programs.
 
 * SYNOPSIS
@@ -49,6 +49,7 @@ The regular expressions are basic case-insensitive PCRE, see *pcre(3)*.
 ** --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                       |
 |-------------+-----------------------------------|
 | plain       | default, simple list              |
@@ -61,12 +62,12 @@ sets the output format to the given value. The following are available:
 | json        | JSON format                       |
 
 
-[1] *CSV is not fully standardized, but *mu cfind* follows some common practices:
+[1] *CSV* is not fully standardized, but *mu cfind* follows some common practices:
 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
+** --personal,-p 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*.
 
@@ -112,6 +113,7 @@ With ~--format=json~, the matching contacts come out as a JSON array, e.g.,
 
 Each contact has the following fields:
 
+#+ATTR_MAN: :disable-caption t
 | property      | description                                                              |
 |---------------+--------------------------------------------------------------------------|
 | ~email~         | the email-address                                                        |

man/mu-easy.7.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-mu easy - a quick introduction to mu
+mu-easy - a quick introduction to mu
 
 * DESCRIPTION
 
@@ -54,7 +54,7 @@ can use the =--maildir= option to specify the top-level directory that should be
 processed. See the *mu-index(1)* man page for more details.
 
 Normally, *mu index* visits all the directories under the top-level Maildir;
-however, you can exclude certain directories (say, the 'trash' or 'spam'
+however, you can exclude certain directories (say, the `trash' or `spam'
 folders) by creating a file called =.noindex= in the directory. When *mu* sees such
 a file, it will exclude this directory and its sub-directories from indexing.
 Also see *.noupdate* in the *mu-index(1)* manpage.
@@ -83,7 +83,7 @@ This should return something like:
 2008-07-31T21:57:25 EEST John Milton <jm@example.com> Fere libenter homines id quod volunt credunt
 #+end_example
 
-This means there is a message to 'julius' with 'fruit' somewhere in the message.
+This means there is a message to `julius' with `fruit' somewhere in the message.
 In this case, it's a message from John Milton. Note that the date format depends
 on your the language/locale you are using.
 
@@ -96,7 +96,7 @@ date/sender/subject. However, we can change this using the =--fields= parameter
 $ mu find --fields="t s" t:julius fruit
 #+end_example
 
-In other words, display the 'To:'-field (t) and the subject (s). This should
+In other words, display the `To:'-field (t) and the subject (s). This should
 return something like:
 #+begin_example
 Julius Caesar <jc@example.com> Fere libenter homines id quod volunt credunt
@@ -121,9 +121,9 @@ from Socrates. This could return something like:
 2008-07-31T21:57:25 EEST John Milton <jm@example.com> Fere libenter homines id quod volunt credunt
 #+end_example
 
-What if we want to see some of the body of the message? You can get a 'summary'
+What if we want to see some of the body of the message? You can get a `summary'
 of the first lines of the message using the =--summary-len= option, which will
-'summarize' the first =n= lines of the message:
+`summarize' the first =n= lines of the message:
 
 #+begin_example
 $ mu find --summary-len=3 napoleon m:/archive
@@ -206,15 +206,15 @@ for:
 #+end_example
 and get mails about soccer, Socrates, society, and so on. Note, it's important
 to quote the search query, otherwise the shell will interpret
-the '*'.
+the `*'.
 
 You can also search for messages with a certain attachment using their
 filename, for example:
 
 #+begin_example
   *$ mu find 'file:pic*'*
 #+end_example
-will get you all messages with an attachment starting with 'pic'.
+will get you all messages with an attachment starting with `pic'.
 
 If you want to find attachments with a certain MIME-type, you can use the
 following:
@@ -232,9 +232,9 @@ Get all messages with image attachments:
 #+end_example
 
 
-Note that (1) the '*' wildcard can only be used as the rightmost thing in a
+Note that (1) the `*' wildcard can only be used as the rightmost thing in a
 search query, and (2) that you need to quote the search term, because
-otherwise your shell will interpret the '*' (expanding it to all files in the
+otherwise your shell will interpret the `*' (expanding it to all files in the
 current directory -- probably not what you want).
 
 * DISPLAYING MESSAGES
@@ -282,7 +282,7 @@ your contacts.
 $ mu cfind julius
 #+end_example
 
-will find all contacts with 'julius' in either name or e-mail address. Note that
+will find all contacts with `julius' in either name or e-mail address. Note that
 *mu cfind* accepts a =regular expression= (as per *pcre(3)*)
 
 *mu cfind* also supports a =--format==-parameter, which sets the output to some

man/mu-extract.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu extract* is the *mu* command to display and save message parts
+mu-extract - display and save message parts
 (attachments), and open them with other tools.
 
 * SYNOPSIS
@@ -27,7 +27,7 @@ with filenames matching that pattern will be extracted. The regular expressions
 are basic PCRE, and are case-sensitive by default; see *pcre(3)* for more details.
 
 Without any options, *mu extract* simply outputs the list of leaf MIME-parts in
-the message. Only 'leaf' MIME-parts (including RFC822 attachments) are
+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
@@ -66,7 +66,7 @@ expressions are basic PCRE, and are case-sensitive by default; see *pcre(3)* for
 more details.
 
 ** --play
-Try to 'play' (open) the attachment with the default application for the
+Try to `play' (open) the attachment with the default application for the
 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
 *MU_PLAY_PROGRAM* environment variable.
@@ -86,7 +86,7 @@ the same name:
 $ mu extract --parts=3,4 --overwrite msgfile
 #+end_example
 
-To extract all files ending in '.jpg' (case-insensitive):
+To extract all files ending in `.jpg' (case-insensitive):
 #+begin_example
 $ mu extract msgfile '.*\.jpg'
 #+end_example

man/mu-find.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu find* - find e-mail messages in the *mu* database.
+mu-find - find e-mail messages in the *mu* database.
 
 * SYNOPSIS
 
@@ -25,7 +25,7 @@ For example:
 $ mu find subject:snow and date:2009..
 #+end_example
 
-would find all messages in 2009 with 'snow' in the subject field, e.g:
+would find all messages in 2009 with `snow' in the subject field, e.g:
 
 #+begin_example
 2009-03-05 17:57:33 EET Lucia  <lucia@example.com> running in the snow
@@ -63,7 +63,7 @@ For example:
 $ mu find subject:snow --fields "d f s"
 #+end_example
 
-lists the date, subject and sender of all messages with 'snow' in the their
+lists the date, subject and sender of all messages with `snow' in the their
 subject.
 
 The table of replacement characters is superset of the list mentions for search
@@ -82,12 +82,12 @@ parameters, such as:
 For the complete list, try the command: ~mu info fields~.
 
 The message flags are described in *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'.
+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
 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:
+`reverse' means that the sort should be reverted - Z-A). Examples include:
 
 #+begin_example
 	cc,c            Cc (carbon-copy) recipient(s)
@@ -164,7 +164,7 @@ This is assuming the GNU *date* command.
 
 ** --exec=<command>
 the ~--exec~ coption causes the =command= to be executed on each matched message;
-for example, to see the raw text of all messages matching 'milkshake', you could
+for example, to see the raw text of all messages matching `milkshake', you could
 use:
 #+begin_example
 $ mu find milkshake --exec='less'
@@ -188,10 +188,10 @@ 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
 messages that are part of the same message thread as some matched messages. This
-is useful if you want Gmail-style 'conversations'.
+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.
@@ -206,7 +206,7 @@ message, as in the following table:
 | other       | |->    | |*>    | |=>       |
 #+end_example
 
-Here, an 'orphan' is a message without a parent message (in the list of
+Here, an `orphan' is a message without a parent message (in the list of
 matches), and a duplicate is a message whose message-id was already seen before;
 not this may not really be the same message, if the message-id was copied.
 
@@ -289,6 +289,7 @@ taking the total number for 10 test runs.
 2. time (repeat 10 mu find "" -n 50000 --include-related --threads > /dev/null)
 
 
+#+ATTR_MAN: :disable-caption t
 |       release | time 1 (sec) | time 2 (sec) |
 |---------------+--------------+--------------|
 |           1.4 | 8.9s         | 59.3s        |

man/mu-help.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu help* is a *mu* command that gives help information about mu commands.
+mu-help - show help information about mu commands.
 
 * SYNOPSIS
 

man/mu-index.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu index* -- index e-mail messages stored in Maildirs
+mu-index - index e-mail messages stored in Maildirs
 
 * SYNOPSIS
 
@@ -50,9 +50,9 @@ below for details.
 The first run of *mu index* may take a few minutes if you have a lot of mail (tens
 of thousands of messages). Fortunately, such a full scan needs to be done only
 once; after that it suffices to index the changes, which goes much faster. See
-the 'PERFORMANCE (i,ii,iii)' below for more information.
+the `PERFORMANCE (i,ii,iii)' below for more information.
 
-The optional 'phase two' of the indexing-process is the removal of messages from
+The optional `phase two' of the indexing-process is the removal of messages 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~.
 
@@ -108,7 +108,7 @@ $ time mu index --quiet
 (more than 56818 messages per second)
 
 Note that each test flushes the caches first; a more common use case might be to
-run *mu index* when new mail has arrived; the cache may stay quite 'warm' in that
+run *mu index* when new mail has arrived; the cache may stay quite `warm' in that
 case:
 
 #+begin_example
@@ -183,6 +183,7 @@ too!
 
 Indexing the the same 93000-message mail corpus with the last few releases:
 
+#+ATTR_MAN: :disable-caption t
 |       release | time (sec) | notes                                    |
 |---------------+------------+------------------------------------------|
 |           1.4 | 160s       |                                          |

man/mu-info.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-~mu info~  - show information
+mu-info  - show information
 
 * SYNOPSIS
 

man/mu-init.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-mu init -- initialize the mu message database
+mu-init - initialize the mu message database
 
 * SYNOPSIS
 
@@ -27,9 +27,9 @@ performed).
 
 ** --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
+contains such an address is considered a `personal' messages; this can then be
 used for filtering in *mu-find(1)*, *mu-cfind(1)* and *mu4e*, e.g. to filter-out
 mailing list messages.
 
@@ -58,7 +58,7 @@ 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'.
+Batch-size 0 is interpreted as `use the default'.
 
 ** --support-ngrams
 
@@ -76,7 +76,7 @@ options.
 
 * NGRAM SUPPORT
 
-*mu*'s underlying Xapian database supports 'ngrams', which improve searching for
+*mu*'s underlying Xapian database supports `ngrams', which improve searching for
 languages/scripts that do not have explicit word breaks, such as Chinese,
 Japanese and Korean. It is fairly intrusive, and influences both indexing and
 query-parsing; it is not enabled by default, and is recommended only if you need

man/mu-mkdir.1.org

@@ -3,7 +3,7 @@
 
 * NAME
 
-*mu mkdir* - create a new Maildir
+mu-mkdir - create a new Maildir
 
 * SYNOPSIS