doc: fix man page reference formatting

This commit is contained in:
Ian Kelling 2018-03-10 15:08:17 -05:00
parent d79f1ff778
commit e96d4a1a34
17 changed files with 65 additions and 65 deletions

View File

@ -17,7 +17,7 @@ database. Each file must be specified with an absolute path.
\fBmu add\fR does not have its own options, but the general options for
determining the location of the database (\fI--muhome\fR) are available. See
\fBmu-index(1)\fR for more information.
\fBmu-index\fR(1) for more information.
.SH RETURN VALUE
@ -43,6 +43,6 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR mu-remove(1)
.BR mu (1),
.BR mu-index (1),
.BR mu-remove (1)

View File

@ -24,13 +24,13 @@ by means of an example:
The \fB[mu]\fR group header is required.
For practical uses of bookmarks, see mu-find(1).
For practical uses of bookmarks, see \fBmu-find\fR(1).
.SH LOCATION
The bookmarks file is read from \fI<muhome>/bookmarks\fR. Typically, this
would be \fI~/.mu/bookmarks\fR, but this can be influenced using the
\fB\-\-muhome\fR parameter for mu-find(1) and mug(1).
\fB\-\-muhome\fR parameter for \fBmu-find\fR(1) and \fBmug\fR(1).
.SH AUTHOR
@ -38,4 +38,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
mu(1) mu-find(1)
.BR mu (1), mu-find (1)

View File

@ -130,7 +130,7 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR mu-find(1)
.BR mu (1),
.BR mu-index (1),
.BR mu-find (1),
.BR pcrepattern(3)

View File

@ -12,7 +12,8 @@ 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 or mu-find man pages.
you are using -- for example, the \fBmu-index\fR(1) or \fBmu-find\fR(1)
man pages.
\fBNOTE\fR: the \fBindex\fR command (and therefore, the ones that
depend on that, such as \fBfind\fR), require that you store your mail
@ -39,7 +40,7 @@ second.
\fBmu index\fR guesses the top-level Maildir to do its job; if it
guesses wrongly, you can use the \fI--maildir\fR option to specify the
top-level directory that should be processed. See the \fBmu-index\fR
top-level directory that should be processed. See the \fBmu-index\fR(1)
man page for more details.
Normally, \fBmu index\fR visits all the directories under the
@ -47,7 +48,7 @@ top-level Maildir; however, you can exclude certain directories (say,
the 'trash' or 'spam' folders) by creating a file called
\fI.noindex\fR in the directory. When \fBmu\fR sees such a file, it
will exclude this directory and its sub-directories from indexing.
Also see \fB.noupdate\fR in the \fBmu-index\fR manpage.
Also see \fB.noupdate\fR in the \fBmu-index\fR(1) manpage.
.SH SEARCHING YOUR E-MAIL
@ -55,7 +56,7 @@ 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 \fBmu-find\fR man page for details, the syntax of the
clients; see the \fBmu-find\fR(1) man page for details, the syntax of the
search parameters and so on. Here, we just give some examples for
common cases.
@ -79,7 +80,7 @@ the date format depends 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 \fI--fields\fR parameter (see the \fBmu-find\fR man page for the
the \fI--fields\fR parameter (see the \fBmu-find\fR(1) man page for the
details):
.nf
@ -291,9 +292,9 @@ Then, you can use them in \fBmutt\fR if you add something like \fBsource
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR mu-find(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(1)
.BR mu (1),
.BR mu-index (1),
.BR mu-find (1),
.BR mu-mkdir (1),
.BR mu-view (1),
.BR mu-extract (1)

View File

@ -97,4 +97,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu (1)

View File

@ -11,13 +11,13 @@ mu find \- find e-mail messages in the \fBmu\fR database.
.SH DESCRIPTION
\fBmu find\fR is the \fBmu\fR command for searching e-mail message
that were stored earlier using \fBmu index(1)\fR.
that were stored earlier using \fBmu index\fR(1).
.SH SEARCHING MAIL
\fBmu find\fR starts a search for messages in the database that match
some search pattern. The search patterns are described in detail in
.BR mu-query
.BR mu-query (7).
.
For example:
@ -48,7 +48,7 @@ For details on the possible queries, see
.SH OPTIONS
Note, some of the important options are described in the \fBmu(1)\fR man-page
Note, some of the important options are described in the \fBmu\fR(1) man-page
and not here, as they apply to multiple mu-commands.
The \fBfind\fR-command has various options that influence the way \fBmu\fR
@ -90,7 +90,7 @@ search parameters; the complete list:
.fi
The message flags are described in \fBmu-query(7)\fR. As an example, a
The message flags are described in \fBmu-query\fR(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'.
@ -204,7 +204,7 @@ which is roughly equivalent to:
.TP
\fB\-b\fR, \fB\-\-bookmark\fR=\fI<bookmark>\fR
use a bookmarked search query. Using this option, a query from your bookmark
file will be prepended to other search queries. See mu-bookmarks(1) for the
file will be prepended to other search queries. See \fBmu-bookmarks\fR(1) for the
details of the bookmarks file.
@ -380,7 +380,6 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR mu-query(7)
.BR mu (1),
.BR mu-index (1),
.BR mu-query (7)

View File

@ -24,11 +24,11 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-index(1)
.BR mu-find(1)
.BR mu-cfind(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(1)
.BR mu-easy(1)
.BR mu-bookmarks(5)
.BR mu-index (1),
.BR mu-find (1),
.BR mu-cfind (1),
.BR mu-mkdir (1),
.BR mu-view (1),
.BR mu-extract (1),
.BR mu-easy (1),
.BR mu-bookmarks (5)

View File

@ -13,10 +13,10 @@ mu index \- index e-mail messages stored in Maildirs
\fBmu index\fR is the \fBmu\fR command for scanning the contents of Maildir
directories and storing the results in a Xapian database. The data can then be
queried using
.BR mu-find(1)\.
.BR mu-find (1)\.
\fBindex\fR understands Maildirs as defined by Daniel Bernstein for
qmail(7). In addition, it understands recursive Maildirs (Maildirs
\fBqmail\fR(7). In addition, it understands recursive Maildirs (Maildirs
within Maildirs), Maildir++. It can also deal with VFAT-based Maildirs
which use '!' as the separators instead of ':'.
@ -245,7 +245,7 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR maildir(5)
.BR mu(1)
.BR mu-find(1)
.BR mu-cfind(1)
.BR maildir (5),
.BR mu (1),
.BR mu-find (1),
.BR mu-cfind (1)

View File

@ -40,6 +40,6 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR maildir(5)
.BR mu(1)
.BR chmod(1)
.BR maildir (5),
.BR mu (1),
.BR chmod (1)

View File

@ -354,4 +354,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-find(1)
.BR mu-find (1)

View File

@ -44,6 +44,6 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR mu-add(1)
.BR mu (1),
.BR mu-index (1),
.BR mu-add (1)

View File

@ -79,5 +79,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR guile(1)
.BR mu (1),
.BR guile (1)

View File

@ -115,7 +115,7 @@ is sent.
If the action is 'open', the attachment will saved to a temporary file, after
which it will be opened with the default handler for this kind of file (see
\fBmu-extract(1)\fR), and a message
\fBmu-extract\fR(1)), and a message
.nf
<- (:info open :message "... has been opened")
.fi
@ -272,4 +272,4 @@ or, alternatively:
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu (1)

View File

@ -75,5 +75,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR gpg(1)
.BR mu (1),
.BR gpg (1)

View File

@ -48,7 +48,7 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1)
.BR mu-index(1)
.BR gpg(1)
.BR gpg-agent(1)
.BR mu (1),
.BR mu-index (1),
.BR gpg (1),
.BR gpg-agent (1)

View File

@ -235,5 +235,5 @@ Please report bugs if you find them:
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
mu-index(1) mu-find(1) mu-cfind(1) mu-mkdir(1) mu-view(1)
mu-extract(1) mu-easy(1) mu-bookmarks(5) mu-query(7)
.BR mu-index (1), mu-find (1), mu-cfind (1), mu-mkdir (1), mu-view (1),
.BR mu-extract (1), mu-easy (1), mu-bookmarks (5), mu-query (7)

View File

@ -37,4 +37,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu(1) mu-bookmarks(5)
.BR mu (1), mu-bookmarks (5)