--- /dev/null
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 3D2B9431FD0\r
+ for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:13 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 1.738\r
+X-Spam-Level: *\r
+X-Spam-Status: No, score=1.738 tagged_above=-999 required=5\r
+ tests=[DNS_FROM_AHBL_RHSBL=2.438, RCVD_IN_DNSWL_LOW=-0.7]\r
+ autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id x13iVYVPBqTX for <notmuch@notmuchmail.org>;\r
+ Tue, 27 Jan 2015 11:48:10 -0800 (PST)\r
+Received: from mail-wi0-f182.google.com (mail-wi0-f182.google.com\r
+ [209.85.212.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id D940C431FCB\r
+ for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:08 -0800 (PST)\r
+Received: by mail-wi0-f182.google.com with SMTP id n3so7346107wiv.3\r
+ for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:07 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=1e100.net; s=20130820;\r
+ h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
+ bh=xfpTrDSeGKO5P4vYzODUH3qqqMH9IHMznVn/F3xQnAs=;\r
+ b=hHwYWWLYLmYJlJPwgFC6kiNEk+5cIBe9FC4NgIfM5hbUPS4GWGP1+f/Aprba8PHz4E\r
+ WaGz/NN8EBSTtYE8ueNjWdfVtC9kxoBMYlkPiSGvVu4CZCnAvJiRxaZayjCeQHEvPYx5\r
+ PyOnbQfsWMpE0TF9Sc7pXDfRaJrIodE2ePwH+/QtKS5pgTpjULyTgdEoWUY3XPXQaxqY\r
+ oczfXckVB29kF5TyCuUovUindefkbjwyheLkuGOEQF1ohnZ1mVWaA6PjFPcfONmyCYHd\r
+ +d2kwlp5D/lkavg0HCG+TffRfbRL5B5BryErCujB50pGTErmv3vlpQVYITLO+krqYk8c\r
+ Wq2w==\r
+X-Gm-Message-State:\r
+ ALoCoQlWEeWpKEN7gen4dud3nXyzJDDOPH6P7Mye4Kb/SnQvUs3mkWd8PusH0ZfquszltLbQ4AFV\r
+X-Received: by 10.194.84.105 with SMTP id x9mr1979180wjy.17.1422388087622;\r
+ Tue, 27 Jan 2015 11:48:07 -0800 (PST)\r
+Received: from localhost (mobile-internet-5d6ab0-235.dhcp.inet.fi.\r
+ [93.106.176.235]) by mx.google.com with ESMTPSA id\r
+ ej10sm19492658wib.1.2015.01.27.11.48.05\r
+ (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+ Tue, 27 Jan 2015 11:48:05 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest\r
+Date: Tue, 27 Jan 2015 21:48:14 +0200\r
+Message-Id: <1422388098-16333-1-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 2.1.4\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 27 Jan 2015 19:48:13 -0000\r
+\r
+Fix indentation of options. Move search terms description before\r
+options. Fix synopsis.\r
+---\r
+ doc/man1/notmuch-dump.rst | 100 ++++++++++++++++++++++++----------------------\r
+ 1 file changed, 53 insertions(+), 47 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst\r
+index d94cb4f84496..3a6d0b34f505 100644\r
+--- a/doc/man1/notmuch-dump.rst\r
++++ b/doc/man1/notmuch-dump.rst\r
+@@ -5,7 +5,7 @@ notmuch-dump\r
+ SYNOPSIS\r
+ ========\r
+ \r
+-**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...]\r
++**notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...]\r
+ \r
+ DESCRIPTION\r
+ ===========\r
+@@ -19,52 +19,58 @@ recreated from the messages themselves. The output of notmuch dump is\r
+ therefore the only critical thing to backup (and much more friendly to\r
+ incremental backup than the native database files.)\r
+ \r
+-``--gzip``\r
+- Compress the output in a format compatible with **gzip(1)**.\r
+-\r
+-``--format=(sup|batch-tag)``\r
+- Notmuch restore supports two plain text dump formats, both with one\r
+- message-id per line, followed by a list of tags.\r
+-\r
+- **batch-tag**\r
+- The default **batch-tag** dump format is intended to more robust\r
+- against malformed message-ids and tags containing whitespace or\r
+- non-\ **ascii(7)** characters. Each line has the form\r
+-\r
+- +<*encoded-tag*\ > +<*encoded-tag*\ > ... --\r
+- id:<*quoted-message-id*\ >\r
+-\r
+- Tags are hex-encoded by replacing every byte not matching the\r
+- regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is the two\r
+- digit hex encoding. The message ID is a valid Xapian query,\r
+- quoted using Xapian boolean term quoting rules: if the ID\r
+- contains whitespace or a close paren or starts with a double\r
+- quote, it must be enclosed in double quotes and double quotes\r
+- inside the ID must be doubled. The astute reader will notice\r
+- this is a special case of the batch input format for\r
+- **notmuch-tag(1)**; note that the single message-id query is\r
+- mandatory for **notmuch-restore(1)**.\r
+-\r
+- **sup**\r
+- The **sup** dump file format is specifically chosen to be\r
+- compatible with the format of files produced by sup-dump. So if\r
+- you've previously been using sup for mail, then the **notmuch\r
+- restore** command provides you a way to import all of your tags\r
+- (or labels as sup calls them). Each line has the following form\r
+-\r
+- <*message-id*\ > **(** <*tag*\ > ... **)**\r
+-\r
+- with zero or more tags are separated by spaces. Note that\r
+- (malformed) message-ids may contain arbitrary non-null\r
+- characters. Note also that tags with spaces will not be\r
+- correctly restored with this format.\r
+-\r
+- With no search terms, a dump of all messages in the database will be\r
+- generated. A "--" argument instructs notmuch that the remaining\r
+- arguments are search terms.\r
+-\r
+- See **notmuch-search-terms(7)** for details of the supported syntax\r
+- for <search-terms>.\r
++See **notmuch-search-terms(7)** for details of the supported syntax\r
++for <search-terms>. With no search terms, a dump of all messages in\r
++the database will be generated. A "--" argument instructs notmuch that\r
++the remaining arguments are search terms.\r
++\r
++Supported options for **dump** include\r
++\r
++ ``--gzip``\r
++ Compress the output in a format compatible with **gzip(1)**.\r
++\r
++ ``--format=(sup|batch-tag)``\r
++ Notmuch restore supports two plain text dump formats, both with one\r
++ message-id per line, followed by a list of tags.\r
++\r
++ **batch-tag**\r
++\r
++ The default **batch-tag** dump format is intended to more\r
++ robust against malformed message-ids and tags containing\r
++ whitespace or non-\ **ascii(7)** characters. Each line has\r
++ the form\r
++\r
++ +<*encoded-tag*\ > +<*encoded-tag*\ > ... --\r
++ id:<*quoted-message-id*\ >\r
++\r
++ Tags are hex-encoded by replacing every byte not matching\r
++ the regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is\r
++ the two digit hex encoding. The message ID is a valid\r
++ Xapian query, quoted using Xapian boolean term quoting\r
++ rules: if the ID contains whitespace or a close paren or\r
++ starts with a double quote, it must be enclosed in double\r
++ quotes and double quotes inside the ID must be\r
++ doubled. The astute reader will notice this is a special\r
++ case of the batch input format for **notmuch-tag(1)**;\r
++ note that the single message-id query is mandatory for\r
++ **notmuch-restore(1)**.\r
++\r
++ **sup**\r
++\r
++ The **sup** dump file format is specifically chosen to be\r
++ compatible with the format of files produced by\r
++ sup-dump. So if you've previously been using sup for mail,\r
++ then the **notmuch restore** command provides you a way to\r
++ import all of your tags (or labels as sup calls\r
++ them). Each line has the following form\r
++\r
++ <*message-id*\ > **(** <*tag*\ > ... **)**\r
++\r
++ with zero or more tags are separated by spaces. Note that\r
++ (malformed) message-ids may contain arbitrary non-null\r
++ characters. Note also that tags with spaces will not be\r
++ correctly restored with this format.\r
++\r
+ \r
+ SEE ALSO\r
+ ========\r
+-- \r
+2.1.4\r
+\r
projects / notmuch-archives.git / commitdiff