From d872cc139b104f4b259801379652d532e4e4de94 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Sun, 2 Dec 2012 15:40:51 +0200 Subject: [PATCH] Re: [Patch v2 16/17] notmuch-{dump, restore}.1: document new format options --- 55/375358b0b0334804e4d081748e9891d91e2c6d | 269 ++++++++++++++++++++++ 1 file changed, 269 insertions(+) create mode 100644 55/375358b0b0334804e4d081748e9891d91e2c6d diff --git a/55/375358b0b0334804e4d081748e9891d91e2c6d b/55/375358b0b0334804e4d081748e9891d91e2c6d new file mode 100644 index 000000000..097983d0c --- /dev/null +++ b/55/375358b0b0334804e4d081748e9891d91e2c6d @@ -0,0 +1,269 @@ +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 41AC7431FAE + for ; Sun, 2 Dec 2012 05:41:01 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 m4QxtjW8g+zv for ; + Sun, 2 Dec 2012 05:40:56 -0800 (PST) +Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com + [209.85.217.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6C6BB431FAF + for ; Sun, 2 Dec 2012 05:40:56 -0800 (PST) +Received: by mail-lb0-f181.google.com with SMTP id ge1so1767585lbb.26 + for ; Sun, 02 Dec 2012 05:40:55 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=from:to:cc:subject:in-reply-to:references:user-agent:date + :message-id:mime-version:content-type:x-gm-message-state; + bh=mNdZAAAJJcUkE8u73nEW9Ev8FaS+H5xlbRRcA9V65R8=; + b=RofEJtvuRJ7/OHM5J1OeVMiZypDGWYnq/lfYBd8M07IUmBRcZE+2iIB3dDqPMW4mSW + d73JcGcH/WFKlNRJDgk2IpcFNc9mVcHYG3aXtPftB/9Vk86tAQ0DBP9mlRxp7DqGAfVh + FNQr19TWblEUS1Wh5MzmzeX0oBSgS9h87rITSTapAiKbxPgGJiaKJf21QQ37P3UvE94X + 2e4sx7WXEudVc/RkL4a3NvazFsFxzUsHBp/kCFekmqiDi0m0YLQjQAp+Xu2Va1nIp9/R + GZvsuWorEXaC+GwR9KWaHfnZ1RDabuKgK2v1BCm3mdSsREzWjfY0xr+bqyH+L/sjl4MQ + gY2A== +Received: by 10.152.124.111 with SMTP id mh15mr6640542lab.20.1354455654902; + Sun, 02 Dec 2012 05:40:54 -0800 (PST) +Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id d5sm4151516lbk.10.2012.12.02.05.40.53 + (version=SSLv3 cipher=OTHER); Sun, 02 Dec 2012 05:40:54 -0800 (PST) +From: Jani Nikula +To: david@tethera.net, notmuch@notmuchmail.org +Subject: Re: [Patch v2 16/17] notmuch-{dump, + restore}.1: document new format options +In-Reply-To: <1353792017-31459-17-git-send-email-david@tethera.net> +References: <1353792017-31459-1-git-send-email-david@tethera.net> + <1353792017-31459-17-git-send-email-david@tethera.net> +User-Agent: Notmuch/0.14+124~g3b17402 (http://notmuchmail.org) Emacs/23.4.1 + (i686-pc-linux-gnu) +Date: Sun, 02 Dec 2012 15:40:51 +0200 +Message-ID: <87wqx0d124.fsf@nikula.org> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Gm-Message-State: + ALoCoQkOeGYqc/hhrnsFXpYNsPPDMq+mkmbrBpB7r8RZtRuziA3yH21biPwfR5oJYLl0+PUDbuwd +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: Sun, 02 Dec 2012 13:41:01 -0000 + +On Sat, 24 Nov 2012, david@tethera.net wrote: +> From: David Bremner +> +> More or less arbitrarily, notmuch-dump.1 gets the more detailed +> description of the format. +> --- +> man/man1/notmuch-dump.1 | 58 +++++++++++++++++++++++++++++++++++++++++++ +> man/man1/notmuch-restore.1 | 59 +++++++++++++++++++++++++++++++++++++++----- +> 2 files changed, 111 insertions(+), 6 deletions(-) +> +> diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 +> index 230deec..9f59905 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,63 @@ 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. + +"followed by tags" is not entirely accurate for batch-tag. + +> + +> +.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 + +Should we deprecate the sup format for new dumps at the same time? Issue +a warning message on dumping too (unless --format is explicitly +specified), telling about the new batch-tag format. I think we should +eventually make batch-tag the default. + +> + +> +.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" "> ... -- " "" " <" encoded-message-id > + +Mention that the id: prefix is present in dump and required in restore. + +BR, +Jani. + +> + +> +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). +> + +> +.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..3860829 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 one message-id +> +per line, and a list 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 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch -- 2.26.2