From: Jani Nikula Date: Sun, 16 Dec 2012 21:02:41 +0000 (+0200) Subject: [PATCH v3 5/5] man: document notmuch search --format=text0 X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=a6eeab0e8b85e07b64b60e6d748216e8fa03a47c;p=notmuch-archives.git [PATCH v3 5/5] man: document notmuch search --format=text0 --- diff --git a/39/69f2692befe99a5ec3775daf6191cfd9e937c9 b/39/69f2692befe99a5ec3775daf6191cfd9e937c9 new file mode 100644 index 000000000..952388ace --- /dev/null +++ b/39/69f2692befe99a5ec3775daf6191cfd9e937c9 @@ -0,0 +1,138 @@ +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 B60E5431FAE + for ; Sun, 16 Dec 2012 13:03:02 -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 0dcKj4fIPM43 for ; + Sun, 16 Dec 2012 13:03:02 -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 F3FFE431FB6 + for ; Sun, 16 Dec 2012 13:03:01 -0800 (PST) +Received: by mail-la0-f53.google.com with SMTP id w12so4045379lag.26 + for ; Sun, 16 Dec 2012 13:03:00 -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=P8LWGdJKXm23XbNO4hNaNYzv8BokoAwARZA29B7btdk=; + b=otGjdnhb8/DRiQU2M4mfCxq8POQIY+vmtDo4eXK2ZspQi/6V+7GEL7+LJXVtWpDLD2 + wAoaKdXsTHr9SMQI86WeFs0JgU8dLsdUz9vzKaXPcgMwxzUnPqTiMQJ3nBRMnudwHuMm + 1anDDj/Iz69b/N4qKybZj0jzYb0EFH9C/haWcjGyiBhUQFVk3u+eusJVADDwrClsX58e + To/oEQiqCE7WxV+USo6h3AXjlR01xBopdeybWsf/2RCfyQ3JyoWzJCTzbwlM/BzDS+W3 + tppp5XISYtz8tJ22/pv1mID3Lh+2r0XpCcyUT6hFh2gs80mESl7ElyjL3PWjInmRuPAj + oi+g== +Received: by 10.112.28.133 with SMTP id b5mr5066978lbh.79.1355691780394; + Sun, 16 Dec 2012 13:03:00 -0800 (PST) +Received: from localhost (dsl-hkibrasgw4-50df51-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id k7sm4117517lbf.4.2012.12.16.13.02.58 + (version=SSLv3 cipher=OTHER); Sun, 16 Dec 2012 13:02:59 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH v3 5/5] man: document notmuch search --format=text0 +Date: Sun, 16 Dec 2012 23:02:41 +0200 +Message-Id: + <75d5a83620ac5262b70133eafa6d7ecf408c7e94.1355691124.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: + ALoCoQkRGt9Gax4D106sshb0vmTYgQ+s/u0ejvwzP07iO1JLprsequUEcy3fvIp5W5ueBz76FLOL +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 21:03:02 -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 0aff348..22bcd0a 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 +@@ -48,32 +50,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 +