From 3b2291bad62482541f4608de255b0b873e6965d8 Mon Sep 17 00:00:00 2001 From: Mark Walters Date: Tue, 24 Jul 2012 19:57:57 +0100 Subject: [PATCH] [PATCH v2] man: show: update man page for entire-thread and json. --- 33/8dcb0886c7ebad1a8dccc049cbc696797473fc | 121 ++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 33/8dcb0886c7ebad1a8dccc049cbc696797473fc diff --git a/33/8dcb0886c7ebad1a8dccc049cbc696797473fc b/33/8dcb0886c7ebad1a8dccc049cbc696797473fc new file mode 100644 index 000000000..c9953cc9d --- /dev/null +++ b/33/8dcb0886c7ebad1a8dccc049cbc696797473fc @@ -0,0 +1,121 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id A6B02431FBD + for ; Tue, 24 Jul 2012 11:58:13 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.201 +X-Spam-Level: +X-Spam-Status: No, score=0.201 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001, + RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id KCeG9HQnIuml for ; + Tue, 24 Jul 2012 11:58:13 -0700 (PDT) +Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com + [74.125.82.45]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client + certificate requested) by olra.theworths.org (Postfix) with ESMTPS id + 0E06E431FAE for ; Tue, 24 Jul 2012 11:58:12 -0700 + (PDT) +Received: by wgbdt14 with SMTP id dt14so6019116wgb.2 + for ; Tue, 24 Jul 2012 11:58:11 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; + bh=JUuaDzfoWOrmpkJhxZ6wdy/YG3/IcXG74OOITvXEIYQ=; + b=WHJIsyeY9hT85201Ag4LY0u949FB/PenGkububHsXgv/X0Rjh9SEXH7O5ax5gsBicE + K6v1c9eQ9pV/zGjFbTWWqxd4aDuibjbtNo1ZqLdrUrIGRfoM5OMJODNxcfqnDM7Vgneq + whAcrmmXQIAQuJh3B8Jb+B58eKGWnGxbBbd0M4b4zQ/9Iu12Ht3qhdxNZNDteCkXRQUa + QhfkTQYWkvAegBnxnPXs/nE/AAoYyhRvuMHf30+mM0P2UsmBBLB1ze4KawqjHa5Z9iZb + hFzBHb8uC3k+zPGajwdw8/B9x1hjsXFcANNtvo0I7/Ds8CiLP0YN5MeDfV+JJ68Vr6xl + dbeA== +Received: by 10.180.76.36 with SMTP id h4mr2354934wiw.13.1343156291779; + Tue, 24 Jul 2012 11:58:11 -0700 (PDT) +Received: from localhost (94-192-233-223.zone6.bethere.co.uk. + [94.192.233.223]) by mx.google.com with ESMTPS id + t8sm5650295wiy.3.2012.07.24.11.58.09 (version=TLSv1/SSLv3 cipher=OTHER); Tue, + 24 Jul 2012 11:58:10 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH v2] man: show: update man page for entire-thread and json. +Date: Tue, 24 Jul 2012 19:57:57 +0100 +Message-Id: <1343156277-28146-1-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <20120722163628.GE31834@mit.edu> +References: <20120722163628.GE31834@mit.edu> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 24 Jul 2012 18:58:13 -0000 + +Previously in notmuch show --format=json implied --entire-thread. This +is still the default but it is now possible to disable this. Update +the manpage to reflect this. +--- + +Update the manpage since --format=json and --entire-thread=false is +now supported. Reworded as Austin suggested. + +Best wishes + +Mark + + man/man1/notmuch-show.1 | 21 +++++++++++++-------- + 1 files changed, 13 insertions(+), 8 deletions(-) + +diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 +index 506583a..765b22c 100644 +--- a/man/man1/notmuch-show.1 ++++ b/man/man1/notmuch-show.1 +@@ -24,11 +24,14 @@ Supported options for + include + .RS 4 + .TP 4 +-.B \-\-entire\-thread ++.B \-\-entire\-thread=(true|false) + +-By default only those messages that match the search terms will be +-displayed. With this option, all messages in the same thread as any +-matched message will be displayed. ++If true, ++.B notmuch show ++outputs all messages in the thread of any message matching the search ++terms; if false, it outputs only the matching messages. For ++.B --format=json ++this defaults to true. For other formats, this defaults to false. + .RE + + .RS 4 +@@ -55,11 +58,13 @@ be nested. + The output is formatted with Javascript Object Notation (JSON). This + format is more robust than the text format for automated + processing. The nested structure of multipart MIME messages is +-reflected in nested JSON output. JSON output always includes all +-messages in a matching thread; in effect ++reflected in nested JSON output. By default JSON output includes all ++messages in a matching thread; that is, by default, + .B \-\-format=json +-implies +-.B \-\-entire\-thread ++sets ++.B "\-\-entire\-thread" ++The caller can disable this behaviour by setting ++.B \-\-entire\-thread=false + + .RE + .RS 4 +-- +1.7.9.1 + -- 2.26.2