From 65c9a37560744eb99ce3bc434127c214c765287a Mon Sep 17 00:00:00 2001 From: david Date: Sun, 9 Dec 2012 18:57:00 +2000 Subject: [PATCH] [Patch v5 10/11] notmuch-{dump, restore}.1: document new format options --- 24/438264284cd253a267679e480b536f09215d0e | 235 ++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 24/438264284cd253a267679e480b536f09215d0e diff --git a/24/438264284cd253a267679e480b536f09215d0e b/24/438264284cd253a267679e480b536f09215d0e new file mode 100644 index 000000000..c3c1f041f --- /dev/null +++ b/24/438264284cd253a267679e480b536f09215d0e @@ -0,0 +1,235 @@ +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 F0B26431FC2 + for ; Sat, 8 Dec 2012 14:57:57 -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 Q2rIM14wg02q for ; + Sat, 8 Dec 2012 14:57:56 -0800 (PST) +Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238]) + (using TLSv1 with cipher AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 751FC429E4A + for ; Sat, 8 Dec 2012 14:57:43 -0800 (PST) +Received: from fctnnbsc30w-142167090129.dhcp-dynamic.fibreop.nb.bellaliant.net + ([142.167.90.129] helo=zancas.localnet) + by tesseract.cs.unb.ca with esmtpsa + (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) + (envelope-from ) + id 1ThTL4-00066m-Hi; Sat, 08 Dec 2012 18:57:42 -0400 +Received: from bremner by zancas.localnet with local (Exim 4.80) + (envelope-from ) + id 1ThTKz-0000r6-1M; Sat, 08 Dec 2012 18:57:37 -0400 +From: david@tethera.net +To: notmuch@notmuchmail.org +Subject: [Patch v5 10/11] notmuch-{dump, + restore}.1: document new format options +Date: Sat, 8 Dec 2012 18:57:00 -0400 +Message-Id: <1355007421-3069-11-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: <1355007421-3069-1-git-send-email-david@tethera.net> +References: <1355007421-3069-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, 08 Dec 2012 22:57:58 -0000 + +From: David Bremner + +More or less arbitrarily, notmuch-dump.1 gets the more detailed +description of the format. +--- + man/man1/notmuch-dump.1 | 59 ++++++++++++++++++++++++++++++++++++++++++++ + man/man1/notmuch-restore.1 | 59 +++++++++++++++++++++++++++++++++++++++----- + 2 files changed, 112 insertions(+), 6 deletions(-) + +diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 +index 230deec..770b00f 100644 +--- a/man/man1/notmuch-dump.1 ++++ b/man/man1/notmuch-dump.1 +@@ -5,6 +5,7 @@ notmuch-dump \- creates a plain-text dump of the tags of each message + .SH SYNOPSIS + + .B "notmuch dump" ++.RB [ "\-\-format=(sup|batch-tag)" "] [--]" + .RI "[ --output=<" filename "> ] [--]" + .RI "[ <" search-term ">...]" + +@@ -19,6 +20,64 @@ recreated from the messages themselves. The output of notmuch dump is + therefore the only critical thing to backup (and much more friendly to + incremental backup than the native database files.) + ++.TP 4 ++.B \-\-format=(sup|batch-tag) ++ ++Notmuch restore supports two plain text dump formats, both with one message-id ++per line, followed by a list of tags. ++ ++.RS 4 ++.TP 4 ++.B sup ++ ++The ++.B sup ++dump file format is specifically chosen to be ++compatible with the format of files produced by sup-dump. ++So if you've previously been using sup for mail, then the ++.B "notmuch restore" ++command provides you a way to import all of your tags (or labels as ++sup calls them). ++Each line has the following form ++ ++.RS 4 ++.RI < message-id > ++.B ( ++.RI < tag "> ..." ++.B ) ++ ++with zero or more tags are separated by spaces. Note that (malformed) ++message-ids may contain arbitrary non-null characters. Note also ++that tags with spaces will not be correctly restored with this format. ++ ++.RE ++ ++.RE ++.RS 4 ++.TP 4 ++.B batch-tag ++ ++The ++.B batch-tag ++dump format is intended to more robust against malformed message-ids ++and tags containing whitespace or non-\fBascii\fR(7) characters. ++Each line has the form ++ ++.RS 4 ++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id > ++ ++where encoded means that every byte not matching the regex ++.B [A-Za-z0-9@=.,_+-] ++is replace by ++.B %nn ++where nn is the two digit hex encoding. ++The astute reader will notice this is a special case of the batch input ++format for \fBnotmuch-tag\fR(1); note that the single message-id query is ++mandatory for \fBnotmuch-restore\fR(1). ++ ++.RE ++ ++ + With no search terms, a dump of all messages in the database will be + generated. A "--" argument instructs notmuch that the + remaining arguments are search terms. +diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1 +index 2fa8733..6bba628 100644 +--- a/man/man1/notmuch-restore.1 ++++ b/man/man1/notmuch-restore.1 +@@ -6,6 +6,7 @@ notmuch-restore \- restores the tags from the given file (see notmuch dump) + + .B "notmuch restore" + .RB [ "--accumulate" ] ++.RB [ "--format=(auto|batch-tag|sup)" ] + .RI "[ --input=<" filename "> ]" + + .SH DESCRIPTION +@@ -15,19 +16,51 @@ Restores the tags from the given file (see + + The input is read from the given filename, if any, or from stdin. + +-Note: The dump file format is specifically chosen to be ++ ++Supported options for ++.B restore ++include ++.RS 4 ++.TP 4 ++.B \-\-accumulate ++ ++The union of the existing and new tags is applied, instead of ++replacing each message's tags as they are read in from the dump file. ++ ++.RE ++.RS 4 ++.TP 4 ++.B \-\-format=(sup|batch-tag|auto) ++ ++Notmuch restore supports two plain text dump formats, with each line ++specifying a message-id and a set of tags. ++For details of the actual formats, see \fBnotmuch-dump\fR(1). ++ ++.RS 4 ++.TP 4 ++.B sup ++ ++The ++.B sup ++dump file format is specifically chosen to be + compatible with the format of files produced by sup-dump. + So if you've previously been using sup for mail, then the + .B "notmuch restore" + command provides you a way to import all of your tags (or labels as + sup calls them). + +-The --accumulate switch causes the union of the existing and new tags to be +-applied, instead of replacing each message's tags as they are read in from the +-dump file. ++.RE ++.RS 4 ++.TP 4 ++.B batch-tag + +-See \fBnotmuch-search-terms\fR(7) +-for details of the supported syntax for . ++The ++.B batch-tag ++dump format is intended to more robust against malformed message-ids ++and tags containing whitespace or non-\fBascii\fR(7) characters. This ++format hex-escapes all characters those outside of a small character ++set, intended to be suitable for e.g. pathnames in most UNIX-like ++systems. + + .B "notmuch restore" + updates the maildir flags according to tag changes if the +@@ -36,6 +69,20 @@ configuration option is enabled. See \fBnotmuch-config\fR(1) for + details. + + .RE ++ ++.RS 4 ++.TP 4 ++.B auto ++ ++This option (the default) tries to guess the format from the ++input. For correctly formed input in either supported format, this ++heuristic, based the fact that batch-tag format contains no parentheses, ++should be accurate. ++ ++.RE ++ ++.RE ++ + .SH SEE ALSO + + \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +-- +1.7.10.4 + -- 2.26.2