From: David Bremner <bremner@debian.org>
Date: Sat, 19 Jan 2013 18:25:55 +0000 (-0400)
Subject: man: document existing top level options
X-Git-Tag: 0.16_rc1~223
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=3d19e6f1fdc179c3957866e29b9bd5da70eb0dce

man: document existing top level options

The options --help and --version were not documented before.  One
could quibble about how useful that documentation is, but we will soon
add more options.
---

diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1
index 69805cb5..6bf9b2e7 100644
--- a/man/man1/notmuch.1
+++ b/man/man1/notmuch.1
@@ -21,7 +21,7 @@
 notmuch \- thread-based email index, search, and tagging
 .SH SYNOPSIS
 .B notmuch
-.IR command " [" args " ...]"
+.RI "[" option " ...] " command  " [" arg " ...]"
 .SH DESCRIPTION
 Notmuch is a command-line based program for indexing, searching,
 reading, and tagging large collections of email messages.
@@ -50,6 +50,26 @@ interfaces to notmuch. The emacs-based interface to notmuch (available under
 in the Notmuch source distribution) is probably the most widely used at
 this time.
 
+.SH OPTIONS
+
+Supported global options for
+.B notmuch
+include
+
+.RS 4
+.TP 4
+.B \-\-help
+
+Print a synopsis of available commands and exit.
+.RE
+
+.RS 4
+.TP 4
+.B \-\-version
+
+Print the installed version of notmuch, and exit.
+.RE
+
 .SH COMMANDS