mu-man: improve typesetting of references

Try to stick to the man-pages(7) standard.
This commit is contained in:
Tristan Riehs
2024-07-22 15:18:46 +09:00
parent d2ec1751eb
commit dcc3807155
18 changed files with 137 additions and 73 deletions

View File

@ -1,5 +1,6 @@
#+TITLE: MU EASY
#+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@"
#+include: macros.inc
* NAME
@ -12,8 +13,8 @@ many options, which are all described in the man pages for the various
sub-commands. This man pages jumps over all of the details and gives examples of
some common use cases. If the use cases described here do not precisely do what
you want, please check the more extensive information in the man page about the
sub-command you are using -- for example, the *mu-index(1)* or *mu-find(1)* man
pages.
sub-command you are using -- for example, the {{{man-link(mu-index,1)}}} or
{{{man-link(mu-find,1)}}} man pages.
*NOTE*: the *index* command (and therefore, the ones that depend on that, such as
*find*), require that you store your mail in the Maildir-format. If you don't do
@ -34,7 +35,7 @@ with the *init* command.
$ mu init
#+end_example
This uses the defaults (see *mu-init(1)* for details on how to change that).
This uses the defaults (see {{{man-link(mu-init,1)}}} for details on how to change that).
* INDEXING YOUR E-MAIL
@ -50,23 +51,23 @@ the speed of your computer, hard drive etc. Usually, indexing should be able to
reach a speed of a few hundred messages per second.
*mu index* guesses the top-level Maildir to do its job; if it guesses wrong, you
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.
can use the *--maildir* option to specify the top-level directory that should be
processed. See the {{{man-link(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'
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.
Also see *.noupdate* in the {{{man-link(mu-index,1)}}} manpage.
* SEARCHING YOUR E-MAIL
After you have indexed your mail, you can start searching it. By default, the
search results are printed on standard output. Alternatively, the output can
take the form of Maildir with symbolic links to the found messages. This enables
integration with e-mail clients; see the *mu-find(1)* man page for details, the
syntax of the search parameters and so on. Here, we just give some examples for
common cases.
integration with e-mail clients; see the {{{man-link(mu-find,1)}}} man page for
details, the syntax of the search parameters and so on. Here, we just give some
examples for common cases.
You can use the *mu fields* command to get information about all possible fields
and flags.
@ -89,7 +90,7 @@ on your the language/locale you are using.
How do we know that the message was sent to Julius Caesar? Well, it's not
visible from the results above, because the default fields that are shown are
date/sender/subject. However, we can change this using the =--fields= parameter
date/sender/subject. However, we can change this using the *--fields* parameter
(try *mu fields* to see all the details):
#+begin_example
@ -122,7 +123,7 @@ from Socrates. This could return something like:
#+end_example
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
of the first lines of the message using the *--summary-len* option, which will
`summarize' the first =n= lines of the message:
#+begin_example
@ -283,9 +284,9 @@ $ mu cfind julius
#+end_example
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* accepts a =regular expression= (as per {{{man-link(pcre,3)}}}
*mu cfind* also supports a =--format==-parameter, which sets the output to some
*mu cfind* also supports a *--format=*-parameter, which sets the output to some
specific format, so the results can be imported into another program. For
example, to export your contact information to a *mutt* address book file, you can
use something like:
@ -300,4 +301,12 @@ to your =muttrc=.
#+include: "prefooter.inc" :minlevel 1
* SEE ALSO
*mu(1)*, *mu-init(1)*, *mu-index(1)*, *mu-find(1)*, *mu-mfind(1)*, *mu-mkdir(1)*, *mu-view(1)*, *mu-extract(1)*
{{{man-link(mu,1)}}},
{{{man-link(mu-init,1)}}},
{{{man-link(mu-index,1)}}},
{{{man-link(mu-find,1)}}},
{{{man-link(mu-mfind,1)}}},
{{{man-link(mu-mkdir,1)}}},
{{{man-link(mu-view,1)}}},
{{{man-link(mu-extract,1)}}}