build and install api docs with doxygen
[notmuch-archives.git] / 33 / 8dcb0886c7ebad1a8dccc049cbc696797473fc
1 Return-Path: <markwalters1009@gmail.com>\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 A6B02431FBD\r
6         for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:13 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: 0.201\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
12         tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
13         FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
14         RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
15 Received: from olra.theworths.org ([127.0.0.1])\r
16         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
17         with ESMTP id KCeG9HQnIuml for <notmuch@notmuchmail.org>;\r
18         Tue, 24 Jul 2012 11:58:13 -0700 (PDT)\r
19 Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com\r
20  [74.125.82.45])        (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
21  certificate requested) by olra.theworths.org (Postfix) with ESMTPS id\r
22  0E06E431FAE    for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:12 -0700\r
23  (PDT)\r
24 Received: by wgbdt14 with SMTP id dt14so6019116wgb.2\r
25         for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:11 -0700 (PDT)\r
26 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
27         h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
28         bh=JUuaDzfoWOrmpkJhxZ6wdy/YG3/IcXG74OOITvXEIYQ=;\r
29         b=WHJIsyeY9hT85201Ag4LY0u949FB/PenGkububHsXgv/X0Rjh9SEXH7O5ax5gsBicE\r
30         K6v1c9eQ9pV/zGjFbTWWqxd4aDuibjbtNo1ZqLdrUrIGRfoM5OMJODNxcfqnDM7Vgneq\r
31         whAcrmmXQIAQuJh3B8Jb+B58eKGWnGxbBbd0M4b4zQ/9Iu12Ht3qhdxNZNDteCkXRQUa\r
32         QhfkTQYWkvAegBnxnPXs/nE/AAoYyhRvuMHf30+mM0P2UsmBBLB1ze4KawqjHa5Z9iZb\r
33         hFzBHb8uC3k+zPGajwdw8/B9x1hjsXFcANNtvo0I7/Ds8CiLP0YN5MeDfV+JJ68Vr6xl\r
34         dbeA==\r
35 Received: by 10.180.76.36 with SMTP id h4mr2354934wiw.13.1343156291779;\r
36         Tue, 24 Jul 2012 11:58:11 -0700 (PDT)\r
37 Received: from localhost (94-192-233-223.zone6.bethere.co.uk.\r
38  [94.192.233.223])      by mx.google.com with ESMTPS id\r
39  t8sm5650295wiy.3.2012.07.24.11.58.09   (version=TLSv1/SSLv3 cipher=OTHER);     Tue,\r
40  24 Jul 2012 11:58:10 -0700 (PDT)\r
41 From: Mark Walters <markwalters1009@gmail.com>\r
42 To: notmuch@notmuchmail.org\r
43 Subject: [PATCH v2] man: show: update man page for entire-thread and json.\r
44 Date: Tue, 24 Jul 2012 19:57:57 +0100\r
45 Message-Id: <1343156277-28146-1-git-send-email-markwalters1009@gmail.com>\r
46 X-Mailer: git-send-email 1.7.9.1\r
47 In-Reply-To: <20120722163628.GE31834@mit.edu>\r
48 References: <20120722163628.GE31834@mit.edu>\r
49 X-BeenThere: notmuch@notmuchmail.org\r
50 X-Mailman-Version: 2.1.13\r
51 Precedence: list\r
52 List-Id: "Use and development of the notmuch mail system."\r
53         <notmuch.notmuchmail.org>\r
54 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
55         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
56 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
57 List-Post: <mailto:notmuch@notmuchmail.org>\r
58 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
59 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
60         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
61 X-List-Received-Date: Tue, 24 Jul 2012 18:58:13 -0000\r
62 \r
63 Previously in notmuch show --format=json implied --entire-thread. This\r
64 is still the default but it is now possible to disable this. Update\r
65 the manpage to reflect this.\r
66 ---\r
67 \r
68 Update the manpage since --format=json and --entire-thread=false is\r
69 now supported. Reworded as Austin suggested.\r
70 \r
71 Best wishes\r
72 \r
73 Mark \r
74 \r
75  man/man1/notmuch-show.1 |   21 +++++++++++++--------\r
76  1 files changed, 13 insertions(+), 8 deletions(-)\r
77 \r
78 diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
79 index 506583a..765b22c 100644\r
80 --- a/man/man1/notmuch-show.1\r
81 +++ b/man/man1/notmuch-show.1\r
82 @@ -24,11 +24,14 @@ Supported options for\r
83  include\r
84  .RS 4\r
85  .TP 4\r
86 -.B \-\-entire\-thread\r
87 +.B \-\-entire\-thread=(true|false)\r
88  \r
89 -By default only those messages that match the search terms will be\r
90 -displayed. With this option, all messages in the same thread as any\r
91 -matched message will be displayed.\r
92 +If true,\r
93 +.B notmuch show\r
94 +outputs all messages in the thread of any message matching the search\r
95 +terms; if false, it outputs only the matching messages. For\r
96 +.B --format=json\r
97 +this defaults to true.  For other formats, this defaults to false.\r
98  .RE\r
99  \r
100  .RS 4\r
101 @@ -55,11 +58,13 @@ be nested.\r
102  The output is formatted with Javascript Object Notation (JSON). This\r
103  format is more robust than the text format for automated\r
104  processing. The nested structure of multipart MIME messages is\r
105 -reflected in nested JSON output. JSON output always includes all\r
106 -messages in a matching thread; in effect\r
107 +reflected in nested JSON output. By default JSON output includes all\r
108 +messages in a matching thread; that is, by default,\r
109  .B \-\-format=json\r
110 -implies\r
111 -.B \-\-entire\-thread\r
112 +sets\r
113 +.B "\-\-entire\-thread"\r
114 +The caller can disable this behaviour by setting\r
115 +.B \-\-entire\-thread=false\r
116  \r
117  .RE\r
118  .RS 4\r
119 -- \r
120 1.7.9.1\r
121 \r