b5/7daa1044358549792e40f977c919bdce1a5019

   1 Return-Path: <jani@nikula.org>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 3D2B9431FD0\r
   6         for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:13 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 1.738\r
  10 X-Spam-Level: *\r
  11 X-Spam-Status: No, score=1.738 tagged_above=-999 required=5\r
  12         tests=[DNS_FROM_AHBL_RHSBL=2.438, RCVD_IN_DNSWL_LOW=-0.7]\r
  13         autolearn=disabled\r
  14 Received: from olra.theworths.org ([127.0.0.1])\r
  15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16         with ESMTP id x13iVYVPBqTX for <notmuch@notmuchmail.org>;\r
  17         Tue, 27 Jan 2015 11:48:10 -0800 (PST)\r
  18 Received: from mail-wi0-f182.google.com (mail-wi0-f182.google.com\r
  19         [209.85.212.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id D940C431FCB\r
  22         for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:08 -0800 (PST)\r
  23 Received: by mail-wi0-f182.google.com with SMTP id n3so7346107wiv.3\r
  24         for <notmuch@notmuchmail.org>; Tue, 27 Jan 2015 11:48:07 -0800 (PST)\r
  25 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
  26         d=1e100.net; s=20130820;\r
  27         h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
  28         bh=xfpTrDSeGKO5P4vYzODUH3qqqMH9IHMznVn/F3xQnAs=;\r
  29         b=hHwYWWLYLmYJlJPwgFC6kiNEk+5cIBe9FC4NgIfM5hbUPS4GWGP1+f/Aprba8PHz4E\r
  30         WaGz/NN8EBSTtYE8ueNjWdfVtC9kxoBMYlkPiSGvVu4CZCnAvJiRxaZayjCeQHEvPYx5\r
  31         PyOnbQfsWMpE0TF9Sc7pXDfRaJrIodE2ePwH+/QtKS5pgTpjULyTgdEoWUY3XPXQaxqY\r
  32         oczfXckVB29kF5TyCuUovUindefkbjwyheLkuGOEQF1ohnZ1mVWaA6PjFPcfONmyCYHd\r
  33         +d2kwlp5D/lkavg0HCG+TffRfbRL5B5BryErCujB50pGTErmv3vlpQVYITLO+krqYk8c\r
  34         Wq2w==\r
  35 X-Gm-Message-State:\r
  36  ALoCoQlWEeWpKEN7gen4dud3nXyzJDDOPH6P7Mye4Kb/SnQvUs3mkWd8PusH0ZfquszltLbQ4AFV\r
  37 X-Received: by 10.194.84.105 with SMTP id x9mr1979180wjy.17.1422388087622;\r
  38         Tue, 27 Jan 2015 11:48:07 -0800 (PST)\r
  39 Received: from localhost (mobile-internet-5d6ab0-235.dhcp.inet.fi.\r
  40         [93.106.176.235]) by mx.google.com with ESMTPSA id\r
  41         ej10sm19492658wib.1.2015.01.27.11.48.05\r
  42         (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
  43         Tue, 27 Jan 2015 11:48:05 -0800 (PST)\r
  44 From: Jani Nikula <jani@nikula.org>\r
  45 To: notmuch@notmuchmail.org\r
  46 Subject: [PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest\r
  47 Date: Tue, 27 Jan 2015 21:48:14 +0200\r
  48 Message-Id: <1422388098-16333-1-git-send-email-jani@nikula.org>\r
  49 X-Mailer: git-send-email 2.1.4\r
  50 X-BeenThere: notmuch@notmuchmail.org\r
  51 X-Mailman-Version: 2.1.13\r
  52 Precedence: list\r
  53 List-Id: "Use and development of the notmuch mail system."\r
  54         <notmuch.notmuchmail.org>\r
  55 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  56         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  57 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  58 List-Post: <mailto:notmuch@notmuchmail.org>\r
  59 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  60 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  61         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  62 X-List-Received-Date: Tue, 27 Jan 2015 19:48:13 -0000\r
  63 \r
  64 Fix indentation of options. Move search terms description before\r
  65 options. Fix synopsis.\r
  66 ---\r
  67  doc/man1/notmuch-dump.rst | 100 ++++++++++++++++++++++++----------------------\r
  68  1 file changed, 53 insertions(+), 47 deletions(-)\r
  69 \r
  70 diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst\r
  71 index d94cb4f84496..3a6d0b34f505 100644\r
  72 --- a/doc/man1/notmuch-dump.rst\r
  73 +++ b/doc/man1/notmuch-dump.rst\r
  74 @@ -5,7 +5,7 @@ notmuch-dump\r
  75  SYNOPSIS\r
  76  ========\r
  77  \r
  78 -**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...]\r
  79 +**notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...]\r
  80  \r
  81  DESCRIPTION\r
  82  ===========\r
  83 @@ -19,52 +19,58 @@ recreated from the messages themselves. The output of notmuch dump is\r
  84  therefore the only critical thing to backup (and much more friendly to\r
  85  incremental backup than the native database files.)\r
  86  \r
  87 -``--gzip``\r
  88 -    Compress the output in a format compatible with **gzip(1)**.\r
  89 -\r
  90 -``--format=(sup|batch-tag)``\r
  91 -    Notmuch restore supports two plain text dump formats, both with one\r
  92 -    message-id per line, followed by a list of tags.\r
  93 -\r
  94 -    **batch-tag**\r
  95 -        The default **batch-tag** dump format is intended to more robust\r
  96 -        against malformed message-ids and tags containing whitespace or\r
  97 -        non-\ **ascii(7)** characters. Each line has the form\r
  98 -\r
  99 -            +<*encoded-tag*\ > +<*encoded-tag*\ > ... --\r
 100 -            id:<*quoted-message-id*\ >\r
 101 -\r
 102 -        Tags are hex-encoded by replacing every byte not matching the\r
 103 -        regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is the two\r
 104 -        digit hex encoding. The message ID is a valid Xapian query,\r
 105 -        quoted using Xapian boolean term quoting rules: if the ID\r
 106 -        contains whitespace or a close paren or starts with a double\r
 107 -        quote, it must be enclosed in double quotes and double quotes\r
 108 -        inside the ID must be doubled. The astute reader will notice\r
 109 -        this is a special case of the batch input format for\r
 110 -        **notmuch-tag(1)**; note that the single message-id query is\r
 111 -        mandatory for **notmuch-restore(1)**.\r
 112 -\r
 113 -    **sup**\r
 114 -        The **sup** dump file format is specifically chosen to be\r
 115 -        compatible with the format of files produced by sup-dump. So if\r
 116 -        you've previously been using sup for mail, then the **notmuch\r
 117 -        restore** command provides you a way to import all of your tags\r
 118 -        (or labels as sup calls them). Each line has the following form\r
 119 -\r
 120 -            <*message-id*\ > **(** <*tag*\ > ... **)**\r
 121 -\r
 122 -        with zero or more tags are separated by spaces. Note that\r
 123 -        (malformed) message-ids may contain arbitrary non-null\r
 124 -        characters. Note also that tags with spaces will not be\r
 125 -        correctly restored with this format.\r
 126 -\r
 127 -    With no search terms, a dump of all messages in the database will be\r
 128 -    generated. A "--" argument instructs notmuch that the remaining\r
 129 -    arguments are search terms.\r
 130 -\r
 131 -    See **notmuch-search-terms(7)** for details of the supported syntax\r
 132 -    for <search-terms>.\r
 133 +See **notmuch-search-terms(7)** for details of the supported syntax\r
 134 +for <search-terms>. With no search terms, a dump of all messages in\r
 135 +the database will be generated. A "--" argument instructs notmuch that\r
 136 +the remaining arguments are search terms.\r
 137 +\r
 138 +Supported options for **dump** include\r
 139 +\r
 140 +    ``--gzip``\r
 141 +        Compress the output in a format compatible with **gzip(1)**.\r
 142 +\r
 143 +    ``--format=(sup|batch-tag)``\r
 144 +        Notmuch restore supports two plain text dump formats, both with one\r
 145 +        message-id per line, followed by a list of tags.\r
 146 +\r
 147 +        **batch-tag**\r
 148 +\r
 149 +            The default **batch-tag** dump format is intended to more\r
 150 +            robust against malformed message-ids and tags containing\r
 151 +            whitespace or non-\ **ascii(7)** characters. Each line has\r
 152 +            the form\r
 153 +\r
 154 +                +<*encoded-tag*\ > +<*encoded-tag*\ > ... --\r
 155 +                id:<*quoted-message-id*\ >\r
 156 +\r
 157 +            Tags are hex-encoded by replacing every byte not matching\r
 158 +            the regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is\r
 159 +            the two digit hex encoding. The message ID is a valid\r
 160 +            Xapian query, quoted using Xapian boolean term quoting\r
 161 +            rules: if the ID contains whitespace or a close paren or\r
 162 +            starts with a double quote, it must be enclosed in double\r
 163 +            quotes and double quotes inside the ID must be\r
 164 +            doubled. The astute reader will notice this is a special\r
 165 +            case of the batch input format for **notmuch-tag(1)**;\r
 166 +            note that the single message-id query is mandatory for\r
 167 +            **notmuch-restore(1)**.\r
 168 +\r
 169 +        **sup**\r
 170 +\r
 171 +            The **sup** dump file format is specifically chosen to be\r
 172 +            compatible with the format of files produced by\r
 173 +            sup-dump. So if you've previously been using sup for mail,\r
 174 +            then the **notmuch restore** command provides you a way to\r
 175 +            import all of your tags (or labels as sup calls\r
 176 +            them). Each line has the following form\r
 177 +\r
 178 +                <*message-id*\ > **(** <*tag*\ > ... **)**\r
 179 +\r
 180 +            with zero or more tags are separated by spaces. Note that\r
 181 +            (malformed) message-ids may contain arbitrary non-null\r
 182 +            characters. Note also that tags with spaces will not be\r
 183 +            correctly restored with this format.\r
 184 +\r
 185  \r
 186  SEE ALSO\r
 187  ========\r
 188 -- \r
 189 2.1.4\r
 190 \r