unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH v3 3/8] man: document notmuch search --duplicate=N
Date: Sat, 17 Aug 2013 15:11:28 +0300	[thread overview]
Message-ID: <fbe62d787c8acb242aa29a3f0c0790e89951bf84.1376741447.git.jani@nikula.org> (raw)
In-Reply-To: <cover.1376741447.git.jani@nikula.org>
In-Reply-To: <cover.1376741447.git.jani@nikula.org>

Document the notmuch search --duplicate=N option.

---

v3: clarify dupe vs. folder prefix per Mark's suggestion
---
 man/man1/notmuch-search.1 |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index 2d6ecaf..f69a4cd 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -80,6 +80,10 @@ Output the filenames of all messages matching the search terms, 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).
+
+Note that each message may have multiple filenames associated with it.
+All of them are included in the output, unless limited with the
+\-\-duplicate=N option.
 .RE
 .RS 4
 .TP 4
@@ -158,6 +162,22 @@ but the "match count" is the number of matching non-excluded messages in the
 thread, rather than the number of matching messages.
 .RE
 
+.RS 4
+.TP 4
+.BR \-\-duplicate=N
+
+Effective with
+.BR --output=files ,
+output the Nth filename associated with each message matching the
+query (N is 1-based). If N is greater than the number of files
+associated with the message, don't print anything.
+
+Note that this option is orthogonal with the
+.BR folder:
+search prefix. The prefix matches messages based on filenames. This
+option filters filenames of the matching messages.
+.RE
+
 .SH EXIT STATUS
 
 This command supports the following special exit status codes
-- 
1.7.10.4

  parent reply	other threads:[~2013-08-17 12:11 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-17 12:11 [PATCH v3 0/8] cli: better tooling support for duplicate messages Jani Nikula
2013-08-17 12:11 ` [PATCH v3 1/8] cli: add --duplicate=N option to notmuch search Jani Nikula
2013-08-17 12:11 ` [PATCH v3 2/8] test: test notmuch search --duplicate=N Jani Nikula
2013-08-17 12:11 ` Jani Nikula [this message]
2013-08-17 12:11 ` [PATCH v3 4/8] cli: add --output=files option to notmuch count Jani Nikula
2013-08-17 12:11 ` [PATCH v3 5/8] test: test notmuch count --output=files Jani Nikula
2013-08-17 12:11 ` [PATCH v3 6/8] man: document " Jani Nikula
2013-08-17 12:11 ` [PATCH v3 7/8] NEWS: cli options for improved duplicate message handling Jani Nikula
2013-08-17 13:36   ` Tomi Ollila
     [not found]     ` <cover.1376830237.git.jani@nikula.org>
2013-08-18 12:52       ` [PATCH v4 " Jani Nikula
2013-08-17 12:11 ` [PATCH v3 8/8] man: clarify folder: prefix regarding duplicate files Jani Nikula
2013-08-21 19:53 ` [PATCH v3 0/8] cli: better tooling support for duplicate messages Tomi Ollila
2013-08-24  7:50 ` Mark Walters
2013-08-24  9:51 ` David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=fbe62d787c8acb242aa29a3f0c0790e89951bf84.1376741447.git.jani@nikula.org \
    --to=jani@nikula.org \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).