e3/9af7fe3672fae4812b50e47d95663898d4a726

   1 Return-Path: <m.walters@qmul.ac.uk>\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 AB7D5431FB6\r
   6         for <notmuch@notmuchmail.org>; Thu,  6 Dec 2012 00:19:16 -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.098\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
  12         tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
  13         NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 FHpxcUrpHbfD for <notmuch@notmuchmail.org>;\r
  17         Thu,  6 Dec 2012 00:19:15 -0800 (PST)\r
  18 Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 8ED20431FAE\r
  22         for <notmuch@notmuchmail.org>; Thu,  6 Dec 2012 00:19:15 -0800 (PST)\r
  23 Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
  24         by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
  25         (envelope-from <m.walters@qmul.ac.uk>)\r
  26         id 1TgWfp-0002Kp-Rq; Thu, 06 Dec 2012 08:19:14 +0000\r
  27 Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
  28         by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
  29         (envelope-from <m.walters@qmul.ac.uk>)\r
  30         id 1TgWfp-0007XS-Br; Thu, 06 Dec 2012 08:19:13 +0000\r
  31 From: Mark Walters <markwalters1009@gmail.com>\r
  32 To: Peter Feigl <craven@gmx.net>, notmuch@notmuchmail.org\r
  33 Subject: Re: [PATCH v3 5/5] Updating man pages for new S-Expression output\r
  34         format.\r
  35 In-Reply-To: <1354779189-12231-6-git-send-email-craven@gmx.net>\r
  36 References: <1354779189-12231-1-git-send-email-craven@gmx.net>\r
  37         <1354779189-12231-6-git-send-email-craven@gmx.net>\r
  38 User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1\r
  39         (x86_64-pc-linux-gnu)\r
  40 Date: Thu, 06 Dec 2012 08:19:17 +0000\r
  41 Message-ID: <87vccfpp8a.fsf@qmul.ac.uk>\r
  42 MIME-Version: 1.0\r
  43 Content-Type: text/plain; charset=us-ascii\r
  44 X-Sender-Host-Address: 93.97.24.31\r
  45 X-QM-SPAM-Info: Sender has good ham record.  :)\r
  46 X-QM-Body-MD5: 8a87035c31f624a20931b5e7465d847e (of first 20000 bytes)\r
  47 X-SpamAssassin-Score: -1.7\r
  48 X-SpamAssassin-SpamBar: -\r
  49 X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
  50         determine if it is\r
  51         spam. We require at least 5.0 points to mark a message as spam.\r
  52         This message scored -1.7 points.\r
  53         Summary of the scoring: \r
  54         * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
  55         *      medium trust\r
  56         *      [138.37.6.40 listed in list.dnswl.org]\r
  57         * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
  58         provider *      (markwalters1009[at]gmail.com)\r
  59         *  0.6 AWL AWL: From: address is in the auto white-list\r
  60 X-QM-Scan-Virus: ClamAV says the message is clean\r
  61 X-BeenThere: notmuch@notmuchmail.org\r
  62 X-Mailman-Version: 2.1.13\r
  63 Precedence: list\r
  64 List-Id: "Use and development of the notmuch mail system."\r
  65         <notmuch.notmuchmail.org>\r
  66 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  67         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  68 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  69 List-Post: <mailto:notmuch@notmuchmail.org>\r
  70 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  71 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  72         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  73 X-List-Received-Date: Thu, 06 Dec 2012 08:19:16 -0000\r
  74 \r
  75 On Thu, 06 Dec 2012, Peter Feigl <craven@gmx.net> wrote:\r
  76 > Add sections about the new S-Expression output format (--format=sexp) to\r
  77 > the notmuch-search, notmuch-reply and notmuch-show man pages.\r
  78 > ---\r
  79 >  man/man1/notmuch-reply.1  | 14 ++++++++++----\r
  80 >  man/man1/notmuch-search.1 | 15 ++++++++-------\r
  81 >  man/man1/notmuch-show.1   | 36 ++++++++++++++++++++++++++++--------\r
  82 >  3 files changed, 46 insertions(+), 19 deletions(-)\r
  83 >\r
  84 > diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1\r
  85 > index d264060..f71d764 100644\r
  86 > --- a/man/man1/notmuch-reply.1\r
  87 > +++ b/man/man1/notmuch-reply.1\r
  88 > @@ -37,7 +37,7 @@ Supported options for\r
  89 >  include\r
  90 >  .RS\r
  91 >  .TP 4\r
  92 > -.BR \-\-format= ( default | json | headers\-only )\r
  93 > +.BR \-\-format= ( default | json | sexp | headers\-only )\r
  94 >  .RS\r
  95 >  .TP 4\r
  96 >  .BR default\r
  97 > @@ -48,6 +48,11 @@ Produces JSON output containing headers for a reply message and the\r
  98 >  contents of the original message. This output can be used by a client\r
  99 >  to create a reply message intelligently.\r
 100 >  .TP\r
 101 > +.BR sexp\r
 102 > +Produces S-Expression output containing headers for a reply message and\r
 103 > +the contents of the original message. This output can be used by a client\r
 104 > +to create a reply message intelligently.\r
 105 > +.TP\r
 106 >  .BR headers\-only\r
 107 >  Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.\r
 108 >  .RE\r
 109 > @@ -74,8 +79,8 @@ user's addresses.\r
 110 >  \r
 111 >  Decrypt any MIME encrypted parts found in the selected content\r
 112 >  (ie. "multipart/encrypted" parts). Status of the decryption will be\r
 113 > -reported (currently only supported with --format=json) and the\r
 114 > -multipart/encrypted part will be replaced by the decrypted\r
 115 > +reported (currently only supported with --format=json and --format=sexp)\r
 116 > +and the multipart/encrypted part will be replaced by the decrypted\r
 117 >  content.\r
 118 >  .RE\r
 119 >  \r
 120 > @@ -89,7 +94,8 @@ id:<message-id>), but it can be useful to reply to several messages at\r
 121 >  once. For example, when a series of patches are sent in a single\r
 122 >  thread, replying to the entire thread allows for the reply to comment\r
 123 >  on issues found in multiple patches. The default format supports\r
 124 > -replying to multiple messages at once, but the JSON format does not.\r
 125 > +replying to multiple messages at once, but the JSON and S-Expression\r
 126 > +format does not.\r
 127 \r
 128 Totally trivial but should be "do not".\r
 129 \r
 130 MW\r
 131 \r
 132 \r
 133 >  .RE\r
 134 >  .RE\r
 135 >  \r
 136 > diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1\r
 137 > index 6ccd3b8..0aff348 100644\r
 138 > --- a/man/man1/notmuch-search.1\r
 139 > +++ b/man/man1/notmuch-search.1\r
 140 > @@ -25,9 +25,9 @@ Supported options for\r
 141 >  include\r
 142 >  .RS 4\r
 143 >  .TP 4\r
 144 > -.BR \-\-format= ( json | text )\r
 145 > +.BR \-\-format= ( json | sexp | text )\r
 146 >  \r
 147 > -Presents the results in either JSON or plain-text (default).\r
 148 > +Presents the results in either JSON, S-Expressions or plain-text (default).\r
 149 >  .RE\r
 150 >  \r
 151 >  .RS 4\r
 152 > @@ -49,7 +49,7 @@ the authors of the thread and the subject.\r
 153 >  \r
 154 >  Output the thread IDs of all threads with any message matching the\r
 155 >  search terms, either one per line (\-\-format=text) or as a JSON array\r
 156 > -(\-\-format=json).\r
 157 > +(\-\-format=json) or an S-Expression list (\-\-format=sexp).\r
 158 >  .RE\r
 159 >  .RS 4\r
 160 >  .TP 4\r
 161 > @@ -57,22 +57,23 @@ search terms, either one per line (\-\-format=text) or as a JSON array\r
 162 >  \r
 163 >  Output the message IDs of all messages matching the search terms,\r
 164 >  either one per line (\-\-format=text) or as a JSON array\r
 165 > -(\-\-format=json).\r
 166 > +(\-\-format=json) or as an S-Expression list (\-\-format=sexp).\r
 167 >  .RE\r
 168 >  .RS 4\r
 169 >  .TP 4\r
 170 >  .B files\r
 171 >  \r
 172 >  Output the filenames of all messages matching the search terms, either\r
 173 > -one per line (\-\-format=text) or as a JSON array (\-\-format=json).\r
 174 > +one per line (\-\-format=text) or as a JSON array (\-\-format=json) or\r
 175 > +as an S-Expression list (\-\-format=sexp).\r
 176 >  .RE\r
 177 >  .RS 4\r
 178 >  .TP 4\r
 179 >  .B tags\r
 180 >  \r
 181 >  Output all tags that appear on any message matching the search terms,\r
 182 > -either one per line (\-\-format=text) or as a JSON array\r
 183 > -(\-\-format=json).\r
 184 > +either one per line (\-\-format=text) or as a JSON array (\-\-format=json)\r
 185 > +or as an S-Expression list (\-\-format=sexp).\r
 186 >  .RE\r
 187 >  .RE\r
 188 >  \r
 189 > diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
 190 > index 4481f21..bd41c48 100644\r
 191 > --- a/man/man1/notmuch-show.1\r
 192 > +++ b/man/man1/notmuch-show.1\r
 193 > @@ -31,12 +31,14 @@ If true,\r
 194 >  outputs all messages in the thread of any message matching the search\r
 195 >  terms; if false, it outputs only the matching messages. For\r
 196 >  .B --format=json\r
 197 > +and\r
 198 > +.B --format=sexp\r
 199 >  this defaults to true.  For other formats, this defaults to false.\r
 200 >  .RE\r
 201 >  \r
 202 >  .RS 4\r
 203 >  .TP 4\r
 204 > -.B \-\-format=(text|json|mbox|raw)\r
 205 > +.B \-\-format=(text|json|sexp|mbox|raw)\r
 206 >  \r
 207 >  .RS 4\r
 208 >  .TP 4\r
 209 > @@ -60,11 +62,29 @@ format is more robust than the text format for automated\r
 210 >  processing. The nested structure of multipart MIME messages is\r
 211 >  reflected in nested JSON output. By default JSON output includes all\r
 212 >  messages in a matching thread; that is, by default,\r
 213 > +\r
 214 >  .B \-\-format=json\r
 215 >  sets\r
 216 >  .B "\-\-entire\-thread"\r
 217 >  The caller can disable this behaviour by setting\r
 218 >  .B \-\-entire\-thread=false\r
 219 > +.RE\r
 220 > +.RS 4\r
 221 > +.TP 4\r
 222 > +.B sexp\r
 223 > +\r
 224 > +The output is formatted as an S-Expression (sexp). This\r
 225 > +format is more robust than the text format for automated\r
 226 > +processing. The nested structure of multipart MIME messages is\r
 227 > +reflected in nested S-Expression output. By default,\r
 228 > +S-Expression output includes all messages in a matching thread;\r
 229 > +that is, by default,\r
 230 > +\r
 231 > +.B \-\-format=sexp\r
 232 > +sets\r
 233 > +.B "\-\-entire\-thread"\r
 234 > +The caller can disable this behaviour by setting\r
 235 > +.B \-\-entire\-thread=false\r
 236 >  \r
 237 >  .RE\r
 238 >  .RS 4\r
 239 > @@ -113,7 +133,7 @@ message.\r
 240 >  Output the single decoded MIME part N of a single message.  The search\r
 241 >  terms must match only a single message.  Message parts are numbered in\r
 242 >  a depth-first walk of the message MIME structure, and are identified\r
 243 > -in the 'json' or 'text' output formats.\r
 244 > +in the 'json', 'sexp' or 'text' output formats.\r
 245 >  .RE\r
 246 >  \r
 247 >  .RS 4\r
 248 > @@ -123,8 +143,8 @@ in the 'json' or 'text' output formats.\r
 249 >  Compute and report the validity of any MIME cryptographic signatures\r
 250 >  found in the selected content (ie. "multipart/signed" parts). Status\r
 251 >  of the signature will be reported (currently only supported with\r
 252 > ---format=json), and the multipart/signed part will be replaced by the\r
 253 > -signed data.\r
 254 > +--format=json and --format=sexp), and the multipart/signed part\r
 255 > +will be replaced by the signed data.\r
 256 >  .RE\r
 257 >  \r
 258 >  .RS 4\r
 259 > @@ -133,9 +153,9 @@ signed data.\r
 260 >  \r
 261 >  Decrypt any MIME encrypted parts found in the selected content\r
 262 >  (ie. "multipart/encrypted" parts). Status of the decryption will be\r
 263 > -reported (currently only supported with --format=json) and the\r
 264 > -multipart/encrypted part will be replaced by the decrypted\r
 265 > -content.  Implies --verify.\r
 266 > +reported (currently only supported with --format=json and\r
 267 > +--format=sexp) and the multipart/encrypted part will be replaced\r
 268 > +by the decrypted content.  Implies --verify.\r
 269 >  .RE\r
 270 >  \r
 271 >  .RS 4\r
 272 > @@ -166,7 +186,7 @@ If true (the default)\r
 273 >  includes the bodies of the messages in the output; if false,\r
 274 >  bodies are omitted.\r
 275 >  .B --body=false\r
 276 > -is only implemented for the json format and it is incompatible with\r
 277 > +is only implemented for the json and sexp formats and it is incompatible with\r
 278 >  .B --part > 0.\r
 279 >  \r
 280 >  This is useful if the caller only needs the headers as body-less\r
 281 > -- \r
 282 > 1.8.0\r
 283 >\r
 284 > _______________________________________________\r
 285 > notmuch mailing list\r
 286 > notmuch@notmuchmail.org\r
 287 > http://notmuchmail.org/mailman/listinfo/notmuch\r