man/*: formatting cleanup

Fix some problems with indentation (controlled by markup) and
whitespace.

- notmuch.1: reformat

  Use .SS macro to make "notmuch setup" a subsection. Introduce another
  subsection for the remaining commands.

- notmuch-config.1: reformat

   Put all the syntax in the synopsis. Supposedly this is the the UNIX way.

- notmuch-reply.1: fix formatting issues.

  Give nicer formatting for synopsis.

  Insert missing SEE ALSO header.

- notmuch-dump.1: reformat using subsections

  These seems more natural, although, as mentioned, it does require
  referring back to the synopsis. Or maybe copying parts of the
  synopsis
This commit is contained in:
David Bremner 2011-12-19 20:53:37 -04:00
parent 2d68f4ca9b
commit 482033f8f8
4 changed files with 11 additions and 21 deletions

View file

@ -16,10 +16,7 @@ The
command can be used to get or set settings int the notmuch
configuration file.
.RS 4
.TP 4
.BR "config get " <section> . <item>
.SS GET
The value of the specified configuration item is printed to stdout. If
the item has multiple values, each value is separated by a newline
@ -36,11 +33,8 @@ Available configuration items include at least
user.other_email
new.tags
.RE
.RS 4
.TP 4
.BR "config set " <section> . "<item> [values ...]"
.SS SET
The specified configuration item is set to the given value. To
specify a multiple-value item, provide each value as a separate

View file

@ -14,8 +14,7 @@ notmuch-dump \- Creates a plain-text dump of the tags of each message.
.SH DESCRIPTION
.TP
.BR dump " [<filename>]"
.SS DUMP
Dump tags for messages matching the given search terms.
@ -31,8 +30,7 @@ With no search terms, a dump of all messages in the database will be
generated. A "--" argument instructs notmuch that the
remaining arguments are search terms.
.TP
.BR restore " [--accumulate] [<filename>]"
.SS RESTORE
Restores the tags from the given file (see
.BR "notmuch dump" ")."

View file

@ -44,6 +44,7 @@ Includes subject and quoted message body.
.BR headers\-only
Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
.RE
.RE
See the
.B "SEARCH SYNTAX"

View file

@ -40,15 +40,14 @@ interface, or more likely, on top of the notmuch library
interface. See http://notmuchmail.org for more about alternate
interfaces to notmuch.
.SH COMMANDS
.SS SETUP
The
.BR setup
.B notmuch setup
command is used to configure Notmuch for first use, (or to reconfigure
it later).
.RS 4
.TP 4
.B setup
Interactively sets up notmuch for first use.
The setup command will prompt for your full name, your primary email
address, any alternate email addresses you use, and the directory
@ -80,7 +79,7 @@ with no command argument will run
if the setup command has not previously been completed.
.RE
.SS OTHER COMMANDS
Several of the notmuch commands accept search terms with a common
syntax. See the
@ -91,11 +90,9 @@ The
.BR search ", " show " and " count
commands are used to query the email database.
The
.B reply
command is useful for preparing a template for an email reply.
.RS 4
The
.B tag