64/e5790c85042b303174d28c5a399dbe2e73f972

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