From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id 12A506DE01F7 for ; Sun, 5 Jun 2016 03:24:41 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: -0.012 X-Spam-Level: X-Spam-Status: No, score=-0.012 tagged_above=-999 required=5 tests=[AWL=-0.001, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id t8Uc8eFP3gBb for ; Sun, 5 Jun 2016 03:24:33 -0700 (PDT) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by arlo.cworth.org (Postfix) with ESMTPS id 1FACB6DE01D0 for ; Sun, 5 Jun 2016 03:24:33 -0700 (PDT) Received: from remotemail by fethera.tethera.net with local (Exim 4.84) (envelope-from ) id 1b9VE9-0004NT-CS; Sun, 05 Jun 2016 06:24:17 -0400 Received: (nullmailer pid 4988 invoked by uid 1000); Sun, 05 Jun 2016 10:24:25 -0000 From: David Bremner To: Daniel Kahn Gillmor , David Bremner , notmuch@notmuchmail.org Subject: [PATCH] doc: document notmuch-dump header line Date: Sun, 5 Jun 2016 07:24:18 -0300 Message-Id: <1465122258-4940-1-git-send-email-david@tethera.net> X-Mailer: git-send-email 2.8.1 In-Reply-To: <87y46mpcbf.fsf@alice.fifthhorseman.net> References: <87y46mpcbf.fsf@alice.fifthhorseman.net> X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.20 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: Sun, 05 Jun 2016 10:24:41 -0000 This was introduced with the libconfig changes, but not documented then. --- doc/man1/notmuch-dump.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index eda9e07..ecbeafe 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -86,7 +86,15 @@ Supported options for **dump** include Output per-message metadata, namely tags. See *format* above for description of the output. - The default is to include both tags and configuration information + The default is to include both tags and configuration + information. As of version 2 of the dump format, there is a + header line of the following form +| + + #notmuch-dump <*format*>:<*version*> <*included*> + + where <*included*> is a comma separated list of the above + options. ``--output=``\ Write output to given file instead of stdout. -- 2.8.1