diff options
| author |  David Bremner <bremner@debian.org> | 2013-01-19 14:25:55 -0400 |
|---|---|---|
| committer | David Bremner <bremner@debian.org> | 2013-01-22 21:19:35 -0400 |
| commit | 3d19e6f1fdc179c3957866e29b9bd5da70eb0dce (patch) | |
| tree | 369e522a09e255a2cb057e095207d7d17ac336e2 /man | |
| parent | 0fa4ded8e53118025a9399cca58a6ad10557dbad (diff) | |
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.
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/notmuch.1 | 22 |
1 files changed, 21 insertions, 1 deletions
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 |