From: david Date: Sat, 19 Jan 2013 18:25:55 +0000 (+2000) Subject: [PATCH 4/7] man: document existing top level options X-Git-Url: http://git.tremily.us/?p=notmuch-archives.git;a=commitdiff_plain;h=5acd1201c939f0fe92979a218750c7309ba1026a [PATCH 4/7] man: document existing top level options --- diff --git a/02/db0b7462ad66a54c633c83375324bc43b0c850 b/02/db0b7462ad66a54c633c83375324bc43b0c850 new file mode 100644 index 000000000..f5eecf4a5 --- /dev/null +++ b/02/db0b7462ad66a54c633c83375324bc43b0c850 @@ -0,0 +1,106 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 15A69431FD0 + for ; Sat, 19 Jan 2013 10:26:44 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id wdKUdCP1yHPK for ; + Sat, 19 Jan 2013 10:26:43 -0800 (PST) +Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238]) + (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id C834F431FD5 + for ; Sat, 19 Jan 2013 10:26:11 -0800 (PST) +Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net + ([156.34.82.78] helo=zancas.localnet) + by tesseract.cs.unb.ca with esmtpsa + (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80) + (envelope-from ) + id 1Twd7J-0007xK-0l; Sat, 19 Jan 2013 14:26:09 -0400 +Received: from bremner by zancas.localnet with local (Exim 4.80) + (envelope-from ) + id 1Twd7D-0005ap-DV; Sat, 19 Jan 2013 14:26:03 -0400 +From: david@tethera.net +To: notmuch@notmuchmail.org +Subject: [PATCH 4/7] man: document existing top level options +Date: Sat, 19 Jan 2013 14:25:55 -0400 +Message-Id: <1358619958-21209-5-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: <1358619958-21209-1-git-send-email-david@tethera.net> +References: <1358619958-21209-1-git-send-email-david@tethera.net> +X-Spam_bar: - +Cc: David Bremner +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 19 Jan 2013 18:26:44 -0000 + +From: David Bremner + +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. +--- + man/man1/notmuch.1 | 22 +++++++++++++++++++++- + 1 file changed, 21 insertions(+), 1 deletion(-) + +diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1 +index 69805cb..6bf9b2e 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 + + +-- +1.7.10.4 +