The NAME section in manpages generally doesn't start with capital
letter (unless the word is 'proper noun') and doesn't end with
period. Notmuch manual pages now matches that "format".
This moves notmuch show to the --exclude=(true|false) naming
scheme. When exclude=false show returns all threads that match
including those that only match in an excluded message. The excluded
messages are flagged.
When exclude=true the behaviour depends on whether --entire-thread is
set. If it is not set then show only returns the messages which match
and are not excluded. If it is set then show returns all messages in
the threads that match in a non-excluded message, flagging the excluded
messages in these threads. The rationale is that it is awkward to use
a thread with some missing messages.
This commit replaces the --no-exclude option with a
--exclude=(true|false|flag) option. The default is to omit the
excluded messages.
The flag option only makes sense if output=summary (as otherwise there
is nowhere to print the flag). In summary output exclude=false and
exclude=flag give almost identical output:
they differ in that with the exclude=flag option the match count
(i.e., the x in [x/n] in the output) is the number of matching
non-excluded messages rather than the number of matching messages.
Note this changes the default for output=summary when no --exclude=
option is given: it used to default to flag and now defaults to true
(i.e. omit excluded messages). This is neccesary to keep the cli
output uncluttered and for speed reasons.
Move the option --no-exclude to the --exclude= scheme. Since there is
no way to flag messages only true and false are implemented. Note
that, for consistency with other commands, this is implemented as a
keyword option rather than a boolean option.
This reverts
dfee0f9 man: remove search.exclude_tags from notmuch-config.1 for 0.12
e83409d NEWS: revert NEWS item for exclude tags for 0.12
e77b031 config: disable addition of exclude tags for 0.12
* man/man1/notmuch-config.1
- SYNOPSIS:
Remove spaces in 'section.item' arg, and indicate that
`notmuch config set' accepts multiple value args.
- DESCRIPTION:
Correct config option to exclude tags from search results.
('search.exclude_tags' instead of 'search.exclude')
Also see commit bb8ab4c8.
notmuch new, restore, and tag commands support maildir flag
synchronization with notmuch tags. Reference the notmuch-config(1) man
page about it in the relevant man pages.
At the risk of duplication between the man page and the configuration
file generated by default, document the notmuch configuration options
in the notmuch config man page.
Existing users of notmuch should not be expected to re-generate their
config file in order to get access to the documentation for new
configuration options.
Include some minor fixes and cleanups while at it.
Add new option --reply-to=(all|sender) to "notmuch reply" to select whether
to reply to all (sender and all recipients), or just sender. Reply to all
remains the default.
Credits to Mark Walters <markwalters1009@gmail.com> for his similar earlier
work where I picked up the basic idea of handling reply-to-sender in
add_recipients_from_message(). All bugs are mine, though.
Signed-off-by: Jani Nikula <jani@nikula.org>
These functions are enough different in their behavior that it's not
really worth it to combine them. They overlap in the format of the
dump file, but we can have a separate page that describes the dump
format, and either reference it or include it. This also keeps things
nice and clean with one page per command.
- Replace references to section X below with page refences.
- Add SEE ALSO to each page. This is a bit error prone, because each
SEE ALSO section is different, i.e. a page does not refer to itself.
Fix some problems with indentation (controlled by markup) and
whitespace.
- notmuch.1: reformat
Use .SS macro to make "notmuch setup" a subsection. Introduce another
subsection for the remaining commands.
- notmuch-config.1: reformat
Put all the syntax in the synopsis. Supposedly this is the the UNIX way.
- notmuch-reply.1: fix formatting issues.
Give nicer formatting for synopsis.
Insert missing SEE ALSO header.
- notmuch-dump.1: reformat using subsections
These seems more natural, although, as mentioned, it does require
referring back to the synopsis. Or maybe copying parts of the
synopsis
These are just for the convenience of testers using $src/man as an
element of MANPATH. They are intentionally omitted from MAN1, so that
they do not interfere with the install.
We mostly just cut and paste the command descriptions into individual
files, with a short header added to each one.
The splitting into subdirectories is to support the use of ./man as an
element in MANPATH, e.g. for testing.
