--- /dev/null
+Return-Path: <nex@nexoid.at>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 7C979431FBF\r
+ for <notmuch@notmuchmail.org>; Thu, 6 Dec 2012 03:45:21 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.001\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.001 tagged_above=-999 required=5\r
+ tests=[FREEMAIL_FROM=0.001] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id w76mvkRNV+lN for <notmuch@notmuchmail.org>;\r
+ Thu, 6 Dec 2012 03:45:19 -0800 (PST)\r
+Received: from mail.nexoid.at (www.nexoid.at [178.79.130.240])\r
+ (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 656AF431FB6\r
+ for <notmuch@notmuchmail.org>; Thu, 6 Dec 2012 03:45:18 -0800 (PST)\r
+Received: by mail.nexoid.at (Postfix, from userid 1000)\r
+ id 54BF811C111; Thu, 6 Dec 2012 12:45:14 +0100 (CET)\r
+From: Peter Feigl <craven@gmx.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v4 5/5] Updating man pages for new S-Expression output format.\r
+Date: Thu, 6 Dec 2012 12:44:59 +0100\r
+Message-Id:\r
+ <361aabe18bfc8db699ee16290acce11cc25d52e6.1354794428.git.craven@gmx.net>\r
+X-Mailer: git-send-email 1.8.0\r
+In-Reply-To: <cover.1354794428.git.craven@gmx.net>\r
+References: <cover.1354794428.git.craven@gmx.net>\r
+In-Reply-To: <cover.1354794428.git.craven@gmx.net>\r
+References: <cover.1354794428.git.craven@gmx.net>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Thu, 06 Dec 2012 11:45:21 -0000\r
+\r
+Add sections about the new S-Expression output format (--format=sexp) to\r
+the notmuch-search, notmuch-reply and notmuch-show man pages.\r
+---\r
+ man/man1/notmuch-reply.1 | 14 ++++++++++----\r
+ man/man1/notmuch-search.1 | 15 ++++++++-------\r
+ man/man1/notmuch-show.1 | 36 ++++++++++++++++++++++++++++--------\r
+ 3 files changed, 46 insertions(+), 19 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1\r
+index d264060..fa04c9e 100644\r
+--- a/man/man1/notmuch-reply.1\r
++++ b/man/man1/notmuch-reply.1\r
+@@ -37,7 +37,7 @@ Supported options for\r
+ include\r
+ .RS\r
+ .TP 4\r
+-.BR \-\-format= ( default | json | headers\-only )\r
++.BR \-\-format= ( default | json | sexp | headers\-only )\r
+ .RS\r
+ .TP 4\r
+ .BR default\r
+@@ -48,6 +48,11 @@ Produces JSON output containing headers for a reply message and the\r
+ contents of the original message. This output can be used by a client\r
+ to create a reply message intelligently.\r
+ .TP\r
++.BR sexp\r
++Produces S-Expression output containing headers for a reply message and\r
++the contents of the original message. This output can be used by a client\r
++to create a reply message intelligently.\r
++.TP\r
+ .BR headers\-only\r
+ Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.\r
+ .RE\r
+@@ -74,8 +79,8 @@ user's addresses.\r
+ \r
+ Decrypt any MIME encrypted parts found in the selected content\r
+ (ie. "multipart/encrypted" parts). Status of the decryption will be\r
+-reported (currently only supported with --format=json) and the\r
+-multipart/encrypted part will be replaced by the decrypted\r
++reported (currently only supported with --format=json and --format=sexp)\r
++and the multipart/encrypted part will be replaced by the decrypted\r
+ content.\r
+ .RE\r
+ \r
+@@ -89,7 +94,8 @@ id:<message-id>), but it can be useful to reply to several messages at\r
+ once. For example, when a series of patches are sent in a single\r
+ thread, replying to the entire thread allows for the reply to comment\r
+ on issues found in multiple patches. The default format supports\r
+-replying to multiple messages at once, but the JSON format does not.\r
++replying to multiple messages at once, but the JSON and S-Expression\r
++formats do not.\r
+ .RE\r
+ .RE\r
+ \r
+diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1\r
+index 6ccd3b8..0aff348 100644\r
+--- a/man/man1/notmuch-search.1\r
++++ b/man/man1/notmuch-search.1\r
+@@ -25,9 +25,9 @@ Supported options for\r
+ include\r
+ .RS 4\r
+ .TP 4\r
+-.BR \-\-format= ( json | text )\r
++.BR \-\-format= ( json | sexp | text )\r
+ \r
+-Presents the results in either JSON or plain-text (default).\r
++Presents the results in either JSON, S-Expressions or plain-text (default).\r
+ .RE\r
+ \r
+ .RS 4\r
+@@ -49,7 +49,7 @@ the authors of the thread and the subject.\r
+ \r
+ Output the thread IDs of all threads with any message matching the\r
+ search terms, either one per line (\-\-format=text) or as a JSON array\r
+-(\-\-format=json).\r
++(\-\-format=json) or an S-Expression list (\-\-format=sexp).\r
+ .RE\r
+ .RS 4\r
+ .TP 4\r
+@@ -57,22 +57,23 @@ search terms, either one per line (\-\-format=text) or as a JSON array\r
+ \r
+ Output the message IDs of all messages matching the search terms,\r
+ either one per line (\-\-format=text) or as a JSON array\r
+-(\-\-format=json).\r
++(\-\-format=json) or as an S-Expression list (\-\-format=sexp).\r
+ .RE\r
+ .RS 4\r
+ .TP 4\r
+ .B files\r
+ \r
+ Output the filenames of all messages matching the search terms, either\r
+-one per line (\-\-format=text) or as a JSON array (\-\-format=json).\r
++one per line (\-\-format=text) or as a JSON array (\-\-format=json) or\r
++as an S-Expression list (\-\-format=sexp).\r
+ .RE\r
+ .RS 4\r
+ .TP 4\r
+ .B tags\r
+ \r
+ Output all tags that appear on any message matching the search terms,\r
+-either one per line (\-\-format=text) or as a JSON array\r
+-(\-\-format=json).\r
++either one per line (\-\-format=text) or as a JSON array (\-\-format=json)\r
++or as an S-Expression list (\-\-format=sexp).\r
+ .RE\r
+ .RE\r
+ \r
+diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+index 4481f21..bd41c48 100644\r
+--- a/man/man1/notmuch-show.1\r
++++ b/man/man1/notmuch-show.1\r
+@@ -31,12 +31,14 @@ If true,\r
+ outputs all messages in the thread of any message matching the search\r
+ terms; if false, it outputs only the matching messages. For\r
+ .B --format=json\r
++and\r
++.B --format=sexp\r
+ this defaults to true. For other formats, this defaults to false.\r
+ .RE\r
+ \r
+ .RS 4\r
+ .TP 4\r
+-.B \-\-format=(text|json|mbox|raw)\r
++.B \-\-format=(text|json|sexp|mbox|raw)\r
+ \r
+ .RS 4\r
+ .TP 4\r
+@@ -60,11 +62,29 @@ format is more robust than the text format for automated\r
+ processing. The nested structure of multipart MIME messages is\r
+ reflected in nested JSON output. By default JSON output includes all\r
+ messages in a matching thread; that is, by default,\r
++\r
+ .B \-\-format=json\r
+ sets\r
+ .B "\-\-entire\-thread"\r
+ The caller can disable this behaviour by setting\r
+ .B \-\-entire\-thread=false\r
++.RE\r
++.RS 4\r
++.TP 4\r
++.B sexp\r
++\r
++The output is formatted as an S-Expression (sexp). This\r
++format is more robust than the text format for automated\r
++processing. The nested structure of multipart MIME messages is\r
++reflected in nested S-Expression output. By default,\r
++S-Expression output includes all messages in a matching thread;\r
++that is, by default,\r
++\r
++.B \-\-format=sexp\r
++sets\r
++.B "\-\-entire\-thread"\r
++The caller can disable this behaviour by setting\r
++.B \-\-entire\-thread=false\r
+ \r
+ .RE\r
+ .RS 4\r
+@@ -113,7 +133,7 @@ message.\r
+ Output the single decoded MIME part N of a single message. The search\r
+ terms must match only a single message. Message parts are numbered in\r
+ a depth-first walk of the message MIME structure, and are identified\r
+-in the 'json' or 'text' output formats.\r
++in the 'json', 'sexp' or 'text' output formats.\r
+ .RE\r
+ \r
+ .RS 4\r
+@@ -123,8 +143,8 @@ in the 'json' or 'text' output formats.\r
+ Compute and report the validity of any MIME cryptographic signatures\r
+ found in the selected content (ie. "multipart/signed" parts). Status\r
+ of the signature will be reported (currently only supported with\r
+---format=json), and the multipart/signed part will be replaced by the\r
+-signed data.\r
++--format=json and --format=sexp), and the multipart/signed part\r
++will be replaced by the signed data.\r
+ .RE\r
+ \r
+ .RS 4\r
+@@ -133,9 +153,9 @@ signed data.\r
+ \r
+ Decrypt any MIME encrypted parts found in the selected content\r
+ (ie. "multipart/encrypted" parts). Status of the decryption will be\r
+-reported (currently only supported with --format=json) and the\r
+-multipart/encrypted part will be replaced by the decrypted\r
+-content. Implies --verify.\r
++reported (currently only supported with --format=json and\r
++--format=sexp) and the multipart/encrypted part will be replaced\r
++by the decrypted content. Implies --verify.\r
+ .RE\r
+ \r
+ .RS 4\r
+@@ -166,7 +186,7 @@ If true (the default)\r
+ includes the bodies of the messages in the output; if false,\r
+ bodies are omitted.\r
+ .B --body=false\r
+-is only implemented for the json format and it is incompatible with\r
++is only implemented for the json and sexp formats and it is incompatible with\r
+ .B --part > 0.\r
+ \r
+ This is useful if the caller only needs the headers as body-less\r
+-- \r
+1.8.0\r
+\r
projects / notmuch-archives.git / commitdiff