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 CB31B431FC2 for ; Sun, 16 Dec 2012 14:05:33 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" X-Spam-Flag: NO X-Spam-Score: -0.7 X-Spam-Level: X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 tests=[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 nXPT6FQjmSIh for ; Sun, 16 Dec 2012 14:05:33 -0800 (PST) Received: from mail-la0-f53.google.com (mail-la0-f53.google.com [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id C34F9431FC0 for ; Sun, 16 Dec 2012 14:05:32 -0800 (PST) Received: by mail-la0-f53.google.com with SMTP id w12so4065444lag.26 for ; Sun, 16 Dec 2012 14:05:31 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references :in-reply-to:references:x-gm-message-state; bh=EMeEDCAmawtoVWH5+YJNMNVajveT4d+wAd+7F/9vc4g=; b=cm2ONuijZAsoWszLKiEe218uZY/5/Y82y8H97/6lzdHxxYA3VyB32eUdo3+qxD24kp psnJITkcxqbBjIijyLNgVCAKDz+rbXIk2f1Ccf/s5WSfRsBRe/qkAXLacldU70Fqne7I xI/FGjFf09oO+w7aTKmF46LP8dA+Q1d21JhORWwXiaGAY0ZfHrFu2Fjn63rN9d9f0KYK 4W3+RkFuRZ2wFxT/IwjTA9cv6vjYwQ4EEpx11YguFYY9ei7fX1Zj11eL0JvuUkSokoxp BJID46SDkJblEWC1vT93b0ItF857Cb0aVsKKPzIbAwTiKIBpEzYPu9E0ZVI/PkHUEy5a FBgA== Received: by 10.152.109.139 with SMTP id hs11mr4462187lab.13.1355695531244; Sun, 16 Dec 2012 14:05:31 -0800 (PST) Received: from localhost (dsl-hkibrasgw4-50df51-27.dhcp.inet.fi. [80.223.81.27]) by mx.google.com with ESMTPS id ne2sm4114694lab.10.2012.12.16.14.05.29 (version=SSLv3 cipher=OTHER); Sun, 16 Dec 2012 14:05:30 -0800 (PST) From: Jani Nikula To: notmuch@notmuchmail.org Subject: [PATCH v4 5/5] man: document notmuch search --format=text0 Date: Mon, 17 Dec 2012 00:05:13 +0200 Message-Id: <7e64522f4416c28a5feee5e4e732fb7fe216b569.1355695036.git.jani@nikula.org> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: References: In-Reply-To: References: X-Gm-Message-State: ALoCoQmEgMk1wdwt1Kkc1ZC+7ZsJKPpDGstUBgNa5zDmcrXXwV5wTCLSqoXzj6Zl+h5YnZtX6o8A 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: Sun, 16 Dec 2012 22:05:34 -0000 --- man/man1/notmuch-search.1 | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index 5c771fa..12f6719 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -25,9 +25,11 @@ Supported options for include .RS 4 .TP 4 -.BR \-\-format= ( json | sexp | text ) +.BR \-\-format= ( json | sexp | text | text0 ) -Presents the results in either JSON, S-Expressions or plain-text (default). +Presents the results in either JSON, S-Expressions, newline character +separated plain-text (default), or null character separated plain-text +(compatible with \fBxargs\fR(1) -0 option where available). .RE .RS 4 @@ -57,32 +59,36 @@ the authors of the thread and the subject. .B threads Output the thread IDs of all threads with any message matching the -search terms, either one per line (\-\-format=text) or as a JSON array -(\-\-format=json) or an S-Expression list (\-\-format=sexp). +search terms, either one per line (\-\-format=text), separated by null +characters (\-\-format=text0), as a JSON array (\-\-format=json), or +an S-Expression list (\-\-format=sexp). .RE .RS 4 .TP 4 .B messages Output the message IDs of all messages matching the search terms, -either one per line (\-\-format=text) or as a JSON array -(\-\-format=json) or as an S-Expression list (\-\-format=sexp). +either one per line (\-\-format=text), separated by null characters +(\-\-format=text0), as a JSON array (\-\-format=json), or as an +S-Expression list (\-\-format=sexp). .RE .RS 4 .TP 4 .B files Output the filenames of all messages matching the search terms, either -one per line (\-\-format=text) or as a JSON array (\-\-format=json) or -as an S-Expression list (\-\-format=sexp). +one per line (\-\-format=text), separated by null characters +(\-\-format=text0), as a JSON array (\-\-format=json), or as an +S-Expression list (\-\-format=sexp). .RE .RS 4 .TP 4 .B tags Output all tags that appear on any message matching the search terms, -either one per line (\-\-format=text) or as a JSON array (\-\-format=json) -or as an S-Expression list (\-\-format=sexp). +either one per line (\-\-format=text), separated by null characters +(\-\-format=text0), as a JSON array (\-\-format=json), or as an +S-Expression list (\-\-format=sexp). .RE .RE -- 1.7.10.4