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.
This commit is contained in:
David Bremner 2013-01-19 14:25:55 -04:00
parent 0fa4ded8e5
commit 3d19e6f1fd

View file

@ -21,7 +21,7 @@
notmuch \- thread-based email index, search, and tagging notmuch \- thread-based email index, search, and tagging
.SH SYNOPSIS .SH SYNOPSIS
.B notmuch .B notmuch
.IR command " [" args " ...]" .RI "[" option " ...] " command " [" arg " ...]"
.SH DESCRIPTION .SH DESCRIPTION
Notmuch is a command-line based program for indexing, searching, Notmuch is a command-line based program for indexing, searching,
reading, and tagging large collections of email messages. 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 in the Notmuch source distribution) is probably the most widely used at
this time. 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 .SH COMMANDS