man/*: formatting cleanup
authorDavid Bremner <bremner@debian.org>
Tue, 20 Dec 2011 00:53:37 +0000 (20:53 -0400)
committerDavid Bremner <bremner@debian.org>
Sat, 31 Dec 2011 19:16:32 +0000 (15:16 -0400)
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

man/man1/notmuch-config.1
man/man1/notmuch-dump.1
man/man1/notmuch-reply.1
man/man1/notmuch.1

index 20389f7ca69942ebc7faead221781ba5d37250f3..055f4380f926136703a61ba55f63709f367afddb 100644 (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
index 9dc311f6d879aeef0b9683872b83c3678c40338b..71925b054214badcb2b8993923a81b120efb17b1 100644 (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" ")."
index eb23925b2389d7f0398c68e1ef55d586deca7847..978d318e3595ef4f5bb5a7a3d8a4dc372be2412e 100644 (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"
index 74f892e8780057c738e90573753f09b99cd63eba..590118742aea0321778c3a781bac9c071e92cca0 100644 (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