e3/6dd7df39688d1ed077c8132267d3f84d0b7fd9

   1 Return-Path: <nex@nexoid.at>\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 7C979431FBF\r
   6         for <notmuch@notmuchmail.org>; Thu,  6 Dec 2012 03:45:21 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
   9 X-Spam-Flag: NO\r
  10 X-Spam-Score: 0.001\r
  11 X-Spam-Level: \r
  12 X-Spam-Status: No, score=0.001 tagged_above=-999 required=5\r
  13         tests=[FREEMAIL_FROM=0.001] 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 w76mvkRNV+lN for <notmuch@notmuchmail.org>;\r
  17         Thu,  6 Dec 2012 03:45:19 -0800 (PST)\r
  18 Received: from mail.nexoid.at (www.nexoid.at [178.79.130.240])\r
  19         (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 656AF431FB6\r
  22         for <notmuch@notmuchmail.org>; Thu,  6 Dec 2012 03:45:18 -0800 (PST)\r
  23 Received: by mail.nexoid.at (Postfix, from userid 1000)\r
  24         id 54BF811C111; Thu,  6 Dec 2012 12:45:14 +0100 (CET)\r
  25 From: Peter Feigl <craven@gmx.net>\r
  26 To: notmuch@notmuchmail.org\r
  27 Subject: [PATCH v4 5/5] Updating man pages for new S-Expression output format.\r
  28 Date: Thu,  6 Dec 2012 12:44:59 +0100\r
  29 Message-Id:\r
  30  <361aabe18bfc8db699ee16290acce11cc25d52e6.1354794428.git.craven@gmx.net>\r
  31 X-Mailer: git-send-email 1.8.0\r
  32 In-Reply-To: <cover.1354794428.git.craven@gmx.net>\r
  33 References: <cover.1354794428.git.craven@gmx.net>\r
  34 In-Reply-To: <cover.1354794428.git.craven@gmx.net>\r
  35 References: <cover.1354794428.git.craven@gmx.net>\r
  36 X-BeenThere: notmuch@notmuchmail.org\r
  37 X-Mailman-Version: 2.1.13\r
  38 Precedence: list\r
  39 List-Id: "Use and development of the notmuch mail system."\r
  40         <notmuch.notmuchmail.org>\r
  41 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  42         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  43 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  44 List-Post: <mailto:notmuch@notmuchmail.org>\r
  45 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  46 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  48 X-List-Received-Date: Thu, 06 Dec 2012 11:45:21 -0000\r
  49 \r
  50 Add sections about the new S-Expression output format (--format=sexp) to\r
  51 the notmuch-search, notmuch-reply and notmuch-show man pages.\r
  52 ---\r
  53  man/man1/notmuch-reply.1  | 14 ++++++++++----\r
  54  man/man1/notmuch-search.1 | 15 ++++++++-------\r
  55  man/man1/notmuch-show.1   | 36 ++++++++++++++++++++++++++++--------\r
  56  3 files changed, 46 insertions(+), 19 deletions(-)\r
  57 \r
  58 diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1\r
  59 index d264060..fa04c9e 100644\r
  60 --- a/man/man1/notmuch-reply.1\r
  61 +++ b/man/man1/notmuch-reply.1\r
  62 @@ -37,7 +37,7 @@ Supported options for\r
  63  include\r
  64  .RS\r
  65  .TP 4\r
  66 -.BR \-\-format= ( default | json | headers\-only )\r
  67 +.BR \-\-format= ( default | json | sexp | headers\-only )\r
  68  .RS\r
  69  .TP 4\r
  70  .BR default\r
  71 @@ -48,6 +48,11 @@ Produces JSON output containing headers for a reply message and the\r
  72  contents of the original message. This output can be used by a client\r
  73  to create a reply message intelligently.\r
  74  .TP\r
  75 +.BR sexp\r
  76 +Produces S-Expression output containing headers for a reply message and\r
  77 +the contents of the original message. This output can be used by a client\r
  78 +to create a reply message intelligently.\r
  79 +.TP\r
  80  .BR headers\-only\r
  81  Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.\r
  82  .RE\r
  83 @@ -74,8 +79,8 @@ user's addresses.\r
  84  \r
  85  Decrypt any MIME encrypted parts found in the selected content\r
  86  (ie. "multipart/encrypted" parts). Status of the decryption will be\r
  87 -reported (currently only supported with --format=json) and the\r
  88 -multipart/encrypted part will be replaced by the decrypted\r
  89 +reported (currently only supported with --format=json and --format=sexp)\r
  90 +and the multipart/encrypted part will be replaced by the decrypted\r
  91  content.\r
  92  .RE\r
  93  \r
  94 @@ -89,7 +94,8 @@ id:<message-id>), but it can be useful to reply to several messages at\r
  95  once. For example, when a series of patches are sent in a single\r
  96  thread, replying to the entire thread allows for the reply to comment\r
  97  on issues found in multiple patches. The default format supports\r
  98 -replying to multiple messages at once, but the JSON format does not.\r
  99 +replying to multiple messages at once, but the JSON and S-Expression\r
 100 +formats do not.\r
 101  .RE\r
 102  .RE\r
 103  \r
 104 diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1\r
 105 index 6ccd3b8..0aff348 100644\r
 106 --- a/man/man1/notmuch-search.1\r
 107 +++ b/man/man1/notmuch-search.1\r
 108 @@ -25,9 +25,9 @@ Supported options for\r
 109  include\r
 110  .RS 4\r
 111  .TP 4\r
 112 -.BR \-\-format= ( json | text )\r
 113 +.BR \-\-format= ( json | sexp | text )\r
 114  \r
 115 -Presents the results in either JSON or plain-text (default).\r
 116 +Presents the results in either JSON, S-Expressions or plain-text (default).\r
 117  .RE\r
 118  \r
 119  .RS 4\r
 120 @@ -49,7 +49,7 @@ the authors of the thread and the subject.\r
 121  \r
 122  Output the thread IDs of all threads with any message matching the\r
 123  search terms, either one per line (\-\-format=text) or as a JSON array\r
 124 -(\-\-format=json).\r
 125 +(\-\-format=json) or an S-Expression list (\-\-format=sexp).\r
 126  .RE\r
 127  .RS 4\r
 128  .TP 4\r
 129 @@ -57,22 +57,23 @@ search terms, either one per line (\-\-format=text) or as a JSON array\r
 130  \r
 131  Output the message IDs of all messages matching the search terms,\r
 132  either one per line (\-\-format=text) or as a JSON array\r
 133 -(\-\-format=json).\r
 134 +(\-\-format=json) or as an S-Expression list (\-\-format=sexp).\r
 135  .RE\r
 136  .RS 4\r
 137  .TP 4\r
 138  .B files\r
 139  \r
 140  Output the filenames of all messages matching the search terms, either\r
 141 -one per line (\-\-format=text) or as a JSON array (\-\-format=json).\r
 142 +one per line (\-\-format=text) or as a JSON array (\-\-format=json) or\r
 143 +as an S-Expression list (\-\-format=sexp).\r
 144  .RE\r
 145  .RS 4\r
 146  .TP 4\r
 147  .B tags\r
 148  \r
 149  Output all tags that appear on any message matching the search terms,\r
 150 -either one per line (\-\-format=text) or as a JSON array\r
 151 -(\-\-format=json).\r
 152 +either one per line (\-\-format=text) or as a JSON array (\-\-format=json)\r
 153 +or as an S-Expression list (\-\-format=sexp).\r
 154  .RE\r
 155  .RE\r
 156  \r
 157 diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
 158 index 4481f21..bd41c48 100644\r
 159 --- a/man/man1/notmuch-show.1\r
 160 +++ b/man/man1/notmuch-show.1\r
 161 @@ -31,12 +31,14 @@ If true,\r
 162  outputs all messages in the thread of any message matching the search\r
 163  terms; if false, it outputs only the matching messages. For\r
 164  .B --format=json\r
 165 +and\r
 166 +.B --format=sexp\r
 167  this defaults to true.  For other formats, this defaults to false.\r
 168  .RE\r
 169  \r
 170  .RS 4\r
 171  .TP 4\r
 172 -.B \-\-format=(text|json|mbox|raw)\r
 173 +.B \-\-format=(text|json|sexp|mbox|raw)\r
 174  \r
 175  .RS 4\r
 176  .TP 4\r
 177 @@ -60,11 +62,29 @@ format is more robust than the text format for automated\r
 178  processing. The nested structure of multipart MIME messages is\r
 179  reflected in nested JSON output. By default JSON output includes all\r
 180  messages in a matching thread; that is, by default,\r
 181 +\r
 182  .B \-\-format=json\r
 183  sets\r
 184  .B "\-\-entire\-thread"\r
 185  The caller can disable this behaviour by setting\r
 186  .B \-\-entire\-thread=false\r
 187 +.RE\r
 188 +.RS 4\r
 189 +.TP 4\r
 190 +.B sexp\r
 191 +\r
 192 +The output is formatted as an S-Expression (sexp). This\r
 193 +format is more robust than the text format for automated\r
 194 +processing. The nested structure of multipart MIME messages is\r
 195 +reflected in nested S-Expression output. By default,\r
 196 +S-Expression output includes all messages in a matching thread;\r
 197 +that is, by default,\r
 198 +\r
 199 +.B \-\-format=sexp\r
 200 +sets\r
 201 +.B "\-\-entire\-thread"\r
 202 +The caller can disable this behaviour by setting\r
 203 +.B \-\-entire\-thread=false\r
 204  \r
 205  .RE\r
 206  .RS 4\r
 207 @@ -113,7 +133,7 @@ message.\r
 208  Output the single decoded MIME part N of a single message.  The search\r
 209  terms must match only a single message.  Message parts are numbered in\r
 210  a depth-first walk of the message MIME structure, and are identified\r
 211 -in the 'json' or 'text' output formats.\r
 212 +in the 'json', 'sexp' or 'text' output formats.\r
 213  .RE\r
 214  \r
 215  .RS 4\r
 216 @@ -123,8 +143,8 @@ in the 'json' or 'text' output formats.\r
 217  Compute and report the validity of any MIME cryptographic signatures\r
 218  found in the selected content (ie. "multipart/signed" parts). Status\r
 219  of the signature will be reported (currently only supported with\r
 220 ---format=json), and the multipart/signed part will be replaced by the\r
 221 -signed data.\r
 222 +--format=json and --format=sexp), and the multipart/signed part\r
 223 +will be replaced by the signed data.\r
 224  .RE\r
 225  \r
 226  .RS 4\r
 227 @@ -133,9 +153,9 @@ signed data.\r
 228  \r
 229  Decrypt any MIME encrypted parts found in the selected content\r
 230  (ie. "multipart/encrypted" parts). Status of the decryption will be\r
 231 -reported (currently only supported with --format=json) and the\r
 232 -multipart/encrypted part will be replaced by the decrypted\r
 233 -content.  Implies --verify.\r
 234 +reported (currently only supported with --format=json and\r
 235 +--format=sexp) and the multipart/encrypted part will be replaced\r
 236 +by the decrypted content.  Implies --verify.\r
 237  .RE\r
 238  \r
 239  .RS 4\r
 240 @@ -166,7 +186,7 @@ If true (the default)\r
 241  includes the bodies of the messages in the output; if false,\r
 242  bodies are omitted.\r
 243  .B --body=false\r
 244 -is only implemented for the json format and it is incompatible with\r
 245 +is only implemented for the json and sexp formats and it is incompatible with\r
 246  .B --part > 0.\r
 247  \r
 248  This is useful if the caller only needs the headers as body-less\r
 249 -- \r
 250 1.8.0\r
 251 \r