Commit graph

52 commits

Author SHA1 Message Date
Peter Feigl
9a989772cb Updating man pages for new S-Expression output format.
Add sections about the new S-Expression output format (--format=sexp) to
the notmuch-search, notmuch-reply and notmuch-show man pages.
2012-12-08 09:30:57 -04:00
Jani Nikula
8262a1b1b0 man: document the date:since..until range queries 2012-10-31 16:57:51 -03:00
Tomi Ollila
69843dd628 {., man}/Makefile.local: edit/remove release-checks.sh related targets
Use new target release-checks in place of verify-version-debian,
verify-version-python verify-version-manpage. This target executes
devel/release-checks.sh which does all the verifications the three
dropped targets did, and some more.
2012-09-05 08:34:01 -03:00
David Bremner
6442a47361 version: propagate version changes
These are the result of running "make update-versions"
2012-08-21 10:43:49 +02:00
David Bremner
19c824c3fd notmuch-restore: replace positional argument for input with option
Since notmuch dump doesn't use positional arguments anymore, it seems
better to be consistent.
2012-08-06 08:52:45 -03:00
David Bremner
760e17488e notmuch-dump: remove deprecated positional argument for output file
The syntax --output=filename is a smaller change than deleting the
output argument completely, and conceivably useful e.g. when running
notmuch under a debugger.
2012-08-06 08:52:33 -03:00
Mark Walters
a89a2b276f man: show: update man page for entire-thread and json.
Previously in notmuch show --format=json implied --entire-thread. This
is still the default but it is now possible to disable this. Update
the manpage to reflect this.
2012-07-25 08:14:48 -03:00
Mark Walters
52e50f7823 man: update man page for the new --body=true|false option 2012-07-24 15:49:21 -03:00
Tomi Ollila
e4b429039f manpages: consistent "format" for NAME section
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".
2012-07-09 15:45:13 -06:00
David Bremner
5973881b77 notmuch 0.13.2 release
-----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.12 (GNU/Linux)
 
 iJwEAAECAAYFAk/LdWUACgkQTiiN/0Um85mL8AP/UosXwRabmZT8WjsJ/tPT0N2s
 zIBguJM7jNwnODZ1kFuS5AjxslbsA3SVubWI1rB5CZwINoF0+f+zc1pHHjAjy61R
 XAbSIQsI+2XvnfvDFnLYzyZb6xUX/Q1vczoJ4o2ngLMW5+kkERWYN+T6Ee291c/D
 MTPvV4fuHxvnFAX+Oig=
 =DiJS
 -----END PGP SIGNATURE-----

Merge tag '0.13.2'

notmuch 0.13.2 release
2012-06-03 11:38:08 -03:00
David Bremner
9d5f73db7a version: update to 0.13.2 2012-06-02 18:10:55 -03:00
David Bremner
d99f15d7ee Merge branch 'release' 2012-05-29 09:07:31 -03:00
Jameson Graef Rollins
dc2877b232 cli: fix documentation about --decrypt for show
Forgot to mention that it implies --verify.
2012-05-25 21:40:31 -03:00
David Bremner
df96c93239 version: bump to 0.13.1 2012-05-25 21:17:54 -03:00
David Bremner
3fb08bc125 version: bump to 0.13 2012-05-15 18:18:45 -03:00
David Bremner
a4b10675bf bump version to 0.13~rc1 2012-05-08 14:49:08 -03:00
Peter Wang
0ff54ab712 man: Document 'config list' command
Document the 'config list' command and its output.
2012-04-28 10:47:27 -03:00
Mark Walters
903327279c cli: move show to the new --exclude= option naming scheme.
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.
2012-04-07 23:05:56 -03:00
Mark Walters
fd62a25f91 cli: move search to the new --exclude= naming scheme.
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.
2012-04-07 23:05:41 -03:00
Mark Walters
785c1e497f cli: move count to the new --exclude=(true|false|flag) naming scheme.
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.
2012-04-07 23:05:18 -03:00
David Bremner
2ee1d8e1c7 Merge branch 'release'
Conflicts:
	NEWS

Conflicts resolved by hand for date of 0.12 release.
2012-03-19 22:48:24 -03:00
David Bremner
c302bfa2f6 update version to 0.12
There may be a few NEWS changes after this, but no code (hopefully).
2012-03-19 22:28:17 -03:00
Adam Wolfe Gordon
92b48c8c98 man: Add --decrypt to reply flags 2012-03-19 21:58:20 -03:00
Adam Wolfe Gordon
71855b72f7 man: Update notmuch-reply man page for JSON format. 2012-03-19 21:57:25 -03:00
Austin Clements
2f25295630 man: Update raw format documentation 2012-03-18 09:14:22 -03:00
David Bremner
fc4e5248d2 notmuch 0.12~rc2 release
-----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.11 (GNU/Linux)
 
 iJwEAAECAAYFAk9lxXUACgkQTiiN/0Um85nz8gP+PdsYdn6jyizOc1LYrWqeccQK
 La9HA5f+pdimEVTE1vRPwJT1Vz0saphiqCzRxNaYTtrFKQZ8Cz3z0pPs6/1mDAhD
 myGd9r5y566TNIxG2OlJHxxnmhoml1LNMLOHpj7ZMnNhrojKa0HmibtXlMR5ZN27
 tFP+UZn0c6Ad0JomezE=
 =IEn+
 -----END PGP SIGNATURE-----

Merge tag '0.12_rc2'

notmuch 0.12~rc2 release
2012-03-18 08:36:33 -03:00
David Bremner
d71cb5e45b bump version to 0.12~rc2 2012-03-18 08:07:00 -03:00
David Bremner
0c20878cce Merge branch 'release' 2012-03-13 22:09:56 -03:00
Jani Nikula
d379e3a0e2 man: update SEE ALSO references in man pages
Drop references to notmuch-part(1). Reference all man pages. Fix man
page section of notmuch-dump(1).
2012-03-13 21:34:44 -03:00
David Bremner
4b3af0e444 Make exclusion visible again
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
2012-03-03 11:56:47 -04:00
David Bremner
ad6a6edb38 Merge branch 'release' 2012-03-03 11:56:36 -04:00
Mark Walters
dfee0f97b9 man: remove search.exclude_tags from notmuch-config.1 for 0.12 2012-03-03 08:33:26 -04:00
Mark Walters
99c318cae4 man: update manpage for notmuch-show --no-exclude option 2012-03-02 08:35:39 -04:00
Mark Walters
4eab10f0f8 cli: Add --no-exclude to the man pages for search and count 2012-03-02 08:25:21 -04:00
David Bremner
916aefc2de bump version to 0.12~rc1
As usual, only `version' is edited by hand. The rest of the changes I
blame on the machine.
2012-03-01 07:47:21 -04:00
Pieter Praet
13235d3535 doc: minor corrections in notmuch-config.1
* 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.
2012-02-29 07:27:44 -04:00
Jani Nikula
bf28c60b9f man: add references to maildir flag synchronization
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.
2012-02-27 22:40:29 -04:00
Jani Nikula
bb8ab4c830 man: document the notmuch configuration settings in notmuch-config(1)
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.
2012-02-27 22:38:18 -04:00
Jani Nikula
8ea82928b9 fix .gitignore for gzipped man pages 2012-01-17 14:52:31 -04:00
Jani Nikula
0f8148e920 cli: add support for replying just to the sender in "notmuch reply"
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>
2012-01-14 11:10:28 -04:00
Jani Nikula
949fd801f8 man: add missing SEE ALSO header to notmuch reply man page
Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-10 06:33:01 -04:00
Jameson Graef Rollins
f3d800124f force install notmuch-setup.1 symlink
This will prevent the install from failing if the link already exists.
2011-12-31 15:16:32 -04:00
Jameson Graef Rollins
f079f5f931 break up dump and restore man pages.
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.
2011-12-31 15:16:32 -04:00
Jameson Graef Rollins
77b8d70600 remove reference to notmuch-part.1 from Makefile.local 2011-12-31 15:16:32 -04:00
David Bremner
af12e5a3ac build-system: update for split man pages
- We have to remove the installation of notmuch.1.gz from the top
level Makefile.local.

- Man pages with multiple names are handled by making relative
  symlinks in the install-man target.

- update version tests and convenience rules for split man pages

  The man page version test still only checks notmuch.1, but the
  location is updated.

  update-man-versions is longer than the one-line previously in
  update-versions mainly because I decided to take the high road and
  stick to POSIX sed (thus, no sed -i). The sed regex itself is more
  complicated to cope with variations in the headers.
2011-12-31 15:16:32 -04:00
David Bremner
7c5695b439 man/*: fixup page references
- 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.
2011-12-31 15:16:32 -04:00
David Bremner
5d13210a09 notmuch-config.1: fix typo 2011-12-31 15:16:32 -04:00
David Bremner
8026b4a9ff notmuch.1: smooth wording.
After most of the content was ripped out of the page, a few words were
needed to glue things back togetehr.
2011-12-31 15:16:32 -04:00
David Bremner
482033f8f8 man/*: formatting cleanup
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
2011-12-31 15:16:32 -04:00
David Bremner
2d68f4ca9b man: add symlinks for notmuch-restore.1 and notmuch-setup.1
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.
2011-12-31 15:16:31 -04:00