--- /dev/null
+Return-Path: <bremner@tethera.net>\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 2962E431FBD\r
+ for <notmuch@notmuchmail.org>; Thu, 6 Dec 2012 17:27:32 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\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 0FFV2goO58k5 for <notmuch@notmuchmail.org>;\r
+ Thu, 6 Dec 2012 17:27:30 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+ (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id E5D17429E32\r
+ for <notmuch@notmuchmail.org>; Thu, 6 Dec 2012 17:27:13 -0800 (PST)\r
+Received: from fctnnbsc30w-142167090129.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+ ([142.167.90.129] helo=zancas.localnet)\r
+ by tesseract.cs.unb.ca with esmtpsa\r
+ (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1Tgmif-0003Nx-71; Thu, 06 Dec 2012 21:27:13 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1TgmiZ-0004ku-R5; Thu, 06 Dec 2012 21:27:07 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v3b 8/9] notmuch-{dump, restore}.1: document new format\r
+ options\r
+Date: Thu, 6 Dec 2012 21:26:46 -0400\r
+Message-Id: <1354843607-17980-9-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1354843607-17980-1-git-send-email-david@tethera.net>\r
+References: <1354843607-17980-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\r
+Cc: David Bremner <bremner@debian.org>\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: Fri, 07 Dec 2012 01:27:32 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+More or less arbitrarily, notmuch-dump.1 gets the more detailed\r
+description of the format.\r
+---\r
+ man/man1/notmuch-dump.1 | 59 ++++++++++++++++++++++++++++++++++++++++++++\r
+ man/man1/notmuch-restore.1 | 59 +++++++++++++++++++++++++++++++++++++++-----\r
+ 2 files changed, 112 insertions(+), 6 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
+index 230deec..770b00f 100644\r
+--- a/man/man1/notmuch-dump.1\r
++++ b/man/man1/notmuch-dump.1\r
+@@ -5,6 +5,7 @@ notmuch-dump \- creates a plain-text dump of the tags of each message\r
+ .SH SYNOPSIS\r
+ \r
+ .B "notmuch dump"\r
++.RB [ "\-\-format=(sup|batch-tag)" "] [--]"\r
+ .RI "[ --output=<" filename "> ] [--]"\r
+ .RI "[ <" search-term ">...]"\r
+ \r
+@@ -19,6 +20,64 @@ 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
++.TP 4\r
++.B \-\-format=(sup|batch-tag)\r
++\r
++Notmuch restore supports two plain text dump formats, both with one message-id\r
++per line, followed by a list of tags.\r
++\r
++.RS 4\r
++.TP 4\r
++.B sup\r
++\r
++The\r
++.B sup\r
++dump file format is specifically chosen to be\r
++compatible with the format of files produced by sup-dump.\r
++So if you've previously been using sup for mail, then the\r
++.B "notmuch restore"\r
++command provides you a way to import all of your tags (or labels as\r
++sup calls them).\r
++Each line has the following form\r
++\r
++.RS 4\r
++.RI < message-id >\r
++.B (\r
++.RI < tag "> ..."\r
++.B )\r
++\r
++with zero or more tags are separated by spaces. Note that (malformed)\r
++message-ids may contain arbitrary non-null characters. Note also\r
++that tags with spaces will not be correctly restored with this format.\r
++\r
++.RE\r
++\r
++.RE\r
++.RS 4\r
++.TP 4\r
++.B batch-tag\r
++\r
++The\r
++.B batch-tag\r
++dump format is intended to more robust against malformed message-ids\r
++and tags containing whitespace or non-\fBascii\fR(7) characters.\r
++Each line has the form\r
++\r
++.RS 4\r
++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id >\r
++\r
++where encoded means that every byte not matching the regex\r
++.B [A-Za-z0-9@=.,_+-]\r
++is replace by\r
++.B %nn\r
++where nn is the two digit hex encoding.\r
++The astute reader will notice this is a special case of the batch input\r
++format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
++mandatory for \fBnotmuch-restore\fR(1).\r
++\r
++.RE\r
++\r
++\r
+ With no search terms, a dump of all messages in the database will be\r
+ generated. A "--" argument instructs notmuch that the\r
+ remaining arguments are search terms.\r
+diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1\r
+index 2fa8733..6bba628 100644\r
+--- a/man/man1/notmuch-restore.1\r
++++ b/man/man1/notmuch-restore.1\r
+@@ -6,6 +6,7 @@ notmuch-restore \- restores the tags from the given file (see notmuch dump)\r
+ \r
+ .B "notmuch restore"\r
+ .RB [ "--accumulate" ]\r
++.RB [ "--format=(auto|batch-tag|sup)" ]\r
+ .RI "[ --input=<" filename "> ]"\r
+ \r
+ .SH DESCRIPTION\r
+@@ -15,19 +16,51 @@ Restores the tags from the given file (see\r
+ \r
+ The input is read from the given filename, if any, or from stdin.\r
+ \r
+-Note: The dump file format is specifically chosen to be\r
++\r
++Supported options for\r
++.B restore\r
++include\r
++.RS 4\r
++.TP 4\r
++.B \-\-accumulate\r
++\r
++The union of the existing and new tags is applied, instead of\r
++replacing each message's tags as they are read in from the dump file.\r
++\r
++.RE\r
++.RS 4\r
++.TP 4\r
++.B \-\-format=(sup|batch-tag|auto)\r
++\r
++Notmuch restore supports two plain text dump formats, with each line\r
++specifying a message-id and a set of tags.\r
++For details of the actual formats, see \fBnotmuch-dump\fR(1).\r
++\r
++.RS 4\r
++.TP 4\r
++.B sup\r
++\r
++The\r
++.B sup\r
++dump file format is specifically chosen to be\r
+ compatible with the format of files produced by sup-dump.\r
+ So if you've previously been using sup for mail, then the\r
+ .B "notmuch restore"\r
+ command provides you a way to import all of your tags (or labels as\r
+ sup calls them).\r
+ \r
+-The --accumulate switch causes the union of the existing and new tags to be\r
+-applied, instead of replacing each message's tags as they are read in from the\r
+-dump file.\r
++.RE\r
++.RS 4\r
++.TP 4\r
++.B batch-tag\r
+ \r
+-See \fBnotmuch-search-terms\fR(7)\r
+-for details of the supported syntax for <search-terms>.\r
++The\r
++.B batch-tag\r
++dump format is intended to more robust against malformed message-ids\r
++and tags containing whitespace or non-\fBascii\fR(7) characters. This\r
++format hex-escapes all characters those outside of a small character\r
++set, intended to be suitable for e.g. pathnames in most UNIX-like\r
++systems.\r
+ \r
+ .B "notmuch restore"\r
+ updates the maildir flags according to tag changes if the\r
+@@ -36,6 +69,20 @@ configuration option is enabled. See \fBnotmuch-config\fR(1) for\r
+ details.\r
+ \r
+ .RE\r
++\r
++.RS 4\r
++.TP 4\r
++.B auto\r
++\r
++This option (the default) tries to guess the format from the\r
++input. For correctly formed input in either supported format, this\r
++heuristic, based the fact that batch-tag format contains no parentheses,\r
++should be accurate.\r
++\r
++.RE\r
++\r
++.RE\r
++\r
+ .SH SEE ALSO\r
+ \r
+ \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
+-- \r
+1.7.10.4\r
+\r
projects / notmuch-archives.git / commitdiff