[PATCH v2 3/7] man: document notmuch search --duplicate=N

[Jani Nikula]

On Sun, 09 Jun 2013, Mark Walters <markwalters1009 at gmail.com> wrote:
> Sorry about that: I meant to cancel the message rather than sending it.
>
> What I was wondering was whether we should change the wording of the
> manpage to make it clear that notmuch search --output=files returns all
> filenames where any of the copies matches the search terms (I think; I
> was going to check before sending anything). In particular, 
>
> notmuch search --output=files folder:a_folder may return filenames not
> in a_folder
>
> (This is slightly more noticeable with this patch than before as 
> notmuch search --output=files --duplicate=1 folder:a_folder could give
> no results in folder a_folder
>
> (None of the above is meant to be a criticism of this patch: I have
> only sent this email due to my accidental sending of the previous message)

No worries, it's a valid point. I tried to address them in the updated
man page for --duplicate=N [1], and in an update to the search terms man
page [2].

BR,
Jani.

[1] id:1370881714-3303-1-git-send-email-jani at nikula.org
[2] id:1370881897-3386-1-git-send-email-jani at nikula.org


>
> Best wishes
>
> Mark
>
>
>
>
> What IOn Sun, 09 Jun 2013, Mark Walters <markwalters1009 at gmail.com> wrote:
>> One thing that slightly bothers me with this set (which in some sense is
>> already true) is doing a search of the form
>>
>> notmuch search --output=files folder:<a_folder>
>>
>> T
>>
>> On Sun, 09 Jun 2013, Jani Nikula <jani at nikula.org> wrote:
>>> ---
>>>  man/man1/notmuch-search.1 |   11 +++++++++++
>>>  1 file changed, 11 insertions(+)
>>>
>>> diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
>>> index 1c1e049..4d8b3d3 100644
>>> --- a/man/man1/notmuch-search.1
>>> +++ b/man/man1/notmuch-search.1
>>> @@ -158,6 +158,17 @@ 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.
>>> +.RE
>>> +
>>>  .SH EXIT STATUS
>>>  
>>>  This command supports the following special exit status codes
>>> -- 
>>> 1.7.10.4
>>>
>>> _______________________________________________
>>> notmuch mailing list
>>> notmuch at notmuchmail.org
>>> http://notmuchmail.org/mailman/listinfo/notmuch