[PATCH 4/7] man: document existing top level options

diff --git a/02/db0b7462ad66a54c633c83375324bc43b0c850 b/02/db0b7462ad66a54c633c83375324bc43b0c850
new file mode 100644 (file)
index 0000000..f5eecf4
--- /dev/null
+++ b/02/db0b7462ad66a54c633c83375324bc43b0c850
@@ -0,0 +1,106 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 15A69431FD0\r
+       for <notmuch@notmuchmail.org>; Sat, 19 Jan 2013 10:26:44 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id wdKUdCP1yHPK for <notmuch@notmuchmail.org>;\r
+       Sat, 19 Jan 2013 10:26:43 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C834F431FD5\r
+       for <notmuch@notmuchmail.org>; Sat, 19 Jan 2013 10:26:11 -0800 (PST)\r
+Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([156.34.82.78] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Twd7J-0007xK-0l; Sat, 19 Jan 2013 14:26:09 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Twd7D-0005ap-DV; Sat, 19 Jan 2013 14:26:03 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 4/7] man: document existing top level options\r
+Date: Sat, 19 Jan 2013 14:25:55 -0400\r
+Message-Id: <1358619958-21209-5-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1358619958-21209-1-git-send-email-david@tethera.net>\r
+References: <1358619958-21209-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\r
+Cc: David Bremner <bremner@debian.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 19 Jan 2013 18:26:44 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+The options --help and --version were not documented before.  One\r
+could quibble about how useful that documentation is, but we will soon\r
+add more options.\r
+---\r
+ man/man1/notmuch.1 |   22 +++++++++++++++++++++-\r
+ 1 file changed, 21 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1\r
+index 69805cb..6bf9b2e 100644\r
+--- a/man/man1/notmuch.1\r
++++ b/man/man1/notmuch.1\r
+@@ -21,7 +21,7 @@\r
+ notmuch \- thread-based email index, search, and tagging\r
+ .SH SYNOPSIS\r
+ .B notmuch\r
+-.IR command " [" args " ...]"\r
++.RI "[" option " ...] " command  " [" arg " ...]"\r
+ .SH DESCRIPTION\r
+ Notmuch is a command-line based program for indexing, searching,\r
+ reading, and tagging large collections of email messages.\r
+@@ -50,6 +50,26 @@ interfaces to notmuch. The emacs-based interface to notmuch (available under\r
+ in the Notmuch source distribution) is probably the most widely used at\r
+ this time.\r
+ \r
++.SH OPTIONS\r
++\r
++Supported global options for\r
++.B notmuch\r
++include\r
++\r
++.RS 4\r
++.TP 4\r
++.B \-\-help\r
++\r
++Print a synopsis of available commands and exit.\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
++.B \-\-version\r
++\r
++Print the installed version of notmuch, and exit.\r
++.RE\r
++\r
+ .SH COMMANDS\r
+ \r
+ \r
+-- \r
+1.7.10.4\r
+\r