From 482033f8f81b19228a7b74458f2b13ee3d6c1a17 Mon Sep 17 00:00:00 2001 From: David Bremner <bremner@debian.org> Date: Mon, 19 Dec 2011 20:53:37 -0400 Subject: [PATCH] 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 --- man/man1/notmuch-config.1 | 10 ++-------- man/man1/notmuch-dump.1 | 6 ++---- man/man1/notmuch-reply.1 | 1 + man/man1/notmuch.1 | 15 ++++++--------- 4 files changed, 11 insertions(+), 21 deletions(-) diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1 index 20389f7c..055f4380 100644 --- a/man/man1/notmuch-config.1 +++ b/man/man1/notmuch-config.1 @@ -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 diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 index 9dc311f6..71925b05 100644 --- a/man/man1/notmuch-dump.1 +++ b/man/man1/notmuch-dump.1 @@ -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" ")." diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1 index eb23925b..978d318e 100644 --- a/man/man1/notmuch-reply.1 +++ b/man/man1/notmuch-reply.1 @@ -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" diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1 index 74f892e8..59011874 100644 --- a/man/man1/notmuch.1 +++ b/man/man1/notmuch.1 @@ -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 -- 2.45.2