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 D8788431FAF for ; Fri, 20 Jul 2012 23:34:21 -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 jIknp0qSr+nK for ; Fri, 20 Jul 2012 23:34:21 -0700 (PDT) Received: from mail-we0-f181.google.com (mail-we0-f181.google.com [74.125.82.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 3D156431FAE for ; Fri, 20 Jul 2012 23:34:21 -0700 (PDT) Received: by weyt57 with SMTP id t57so3444218wey.26 for ; Fri, 20 Jul 2012 23:34:18 -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; bh=5s4OhLfjh/Boq8tRfbWCLWyTAOZkEtw0L+VZ4KIQ7aw=; b=EwsIFotH6cOv3gRbGpmR/fzPosYvQIAsBeU7ojJ8IfpSBmLcV0qLiCa9AmXNuqxtjl nyxG9kvsPwR6WRY7BTWNbuU4WIiWVAhVRCHLguLA/KOJFRWWAJvmGMb8qYv38UoUwdER kuWKiKU6KPpjfnpJUjYx6Ljz5+14HppuhN6LQT5uIBoUdNgGdhJEUHS+EyH1tv0UJCny Kv1nfQjKNdFm4T5SUdjyF41m2NxpX+y9QPz8jsTZAtKIDn0Ct0NXyd8ebgSfCKRDIEng 2gWkIEfV3HM84YIa7XQ+PnthMtDkDjIg267c/nI6LfopDarq0a0p9WnT/k/kJCMJV7jB faYg== Received: by 10.180.98.200 with SMTP id ek8mr12843187wib.0.1342852458382; Fri, 20 Jul 2012 23:34:18 -0700 (PDT) Received: from localhost (94-192-233-223.zone6.bethere.co.uk. [94.192.233.223]) by mx.google.com with ESMTPS id t8sm2037305wiy.3.2012.07.20.23.34.16 (version=TLSv1/SSLv3 cipher=OTHER); Fri, 20 Jul 2012 23:34:17 -0700 (PDT) From: Mark Walters To: notmuch@notmuchmail.org Subject: [PATCH] man: show: update man page for entire-thread and json. Date: Sat, 21 Jul 2012 07:34:08 +0100 Message-Id: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com> X-Mailer: git-send-email 1.7.9.1 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: Sat, 21 Jul 2012 06:34:22 -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. --- I didn't update the manpage in the recent patch series. This corrects that omission. (Less cumbersome wording gratefully received) Best wishes Mark man/man1/notmuch-show.1 | 16 +++++++++------- 1 files changed, 9 insertions(+), 7 deletions(-) diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index b51a54c..5fa590e 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -26,9 +26,9 @@ include .TP 4 .B \-\-entire\-thread -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. +By default (except when format=json) 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. .RE .RS 4 @@ -55,11 +55,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