Commit graph

95 commits

Author SHA1 Message Date
David Bremner
fa27d0faa0 man: escape backslash in notmuch-tag example
The example was originally intended to have a literal backslash in it, but
'\ ' is interpreted by nroff as a non-breaking space.

It doesn't make much difference to the example, but the non-breaking
space triggers a bug in doclifter.
2014-02-23 08:56:40 -04:00
David Bremner
01b82dc780 man: fix typo in notmuch.1
Fix for Debian bug 739556
2014-02-21 21:22:55 -04:00
Jani Nikula
aa57e9d2b8 man: document notmuch new --quiet option 2014-01-26 09:52:20 -04:00
David Bremner
5dd59d2a5e man: update notmuch-dump man page for new default.
Actually the previous default was not documented explicitely.  I moved
the batch-tag section first because it seemed that the formats were
previously documented in order default, other.
2014-01-24 08:52:22 -04:00
David Bremner
ceef57b3d9 version: bump to 0.17 2013-12-30 20:34:23 -04:00
David Bremner
05b534209d version: bump to 0.17~rc4
Unfortunately release-checks.sh will whine a bit because it has not
caught up with the renaming of the version macros.
2013-12-28 18:40:05 -04:00
David Bremner
bb390f89a1 version: bump version
Roll (one last?) release candidate because of Austin's
LIBNOTMUCH_VERSION changes.

Atomically bump the manually (NEWS, debian/changelog) and
automatically (everywhere else) updated places version is mentioned.
2013-12-07 17:07:15 +08:00
David Bremner
6c9cd7d20c version: bump to 0.17~rc2 2013-11-28 21:00:52 -04:00
David Bremner
bd0c56b2bd version: bump to 0.17~rc1
Various other files are synched using "make update-versions".  NEWS
has to be hand edited.
2013-11-23 20:29:46 -04:00
Jani Nikula
85e95c0844 man: document notmuch compact --quiet and --backup=DIRECTORY options 2013-11-07 19:16:15 -04:00
Ben Gamari
1f5ae4e00f notmuch-compact: Add man page
Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
2013-10-09 21:47:39 -03:00
John Lenz
f735a85c28 cli: add --include-html option to notmuch show
For my client, the largest bottleneck for displaying large threads is
exporting each html part individually since by default notmuch will not
show the json parts.  For large threads there can be quite a few parts and
each must be exported and decoded one by one.  Also, I then have to deal
with all the crazy charsets which I can do through a library but is a
pain.

Therefore, this patch adds an --include-html option that causes the
text/html parts to be included as part of the output of show.

diff man/man1/notmuch-show.1
2013-08-27 07:57:36 -03:00
Jani Nikula
312837e46a man: document notmuch count --output=files
Document the notmuch count --output=files option.
2013-08-24 11:44:23 +02:00
Jani Nikula
cbc1b143db man: document notmuch search --duplicate=N
Document the notmuch search --duplicate=N option.
2013-08-24 11:42:30 +02:00
Austin Clements
dc51bf0ad4 reply: Use RFC 2822/MIME wholly for text format template
Previously, reply's default text format used an odd mix of RFC 2045
MIME encoding for the reply template's body and some made-up RFC
2822-like UTF-8 format for the headers.  The intent was to present the
headers to the user in a nice, un-encoded format, but this assumed
that whatever ultimately sent the email would RFC 2047-encode the
headers, while at the same time the body was already RFC 2045 encoded,
so it assumed that whatever sent the email would *not* re-encode the
body.

This can be fixed by either producing a fully decoded UTF-8 reply
template, or a fully encoded MIME-compliant RFC 2822 message.  This
patch does the latter because it is

a) Well-defined by RFC 2822 and MIME (while any UTF-8 format would be
   ad hoc).

b) Ready to be piped to sendmail.  The point of the text format is to
   be minimal, so a user should be able to pop up the template in
   whatever editor they want, edit it, and push it to sendmail.

c) Consistent with frontend capabilities.  If a frontend has the
   smarts to RFC 2047 encode the headers before sending the mail, it
   probably has the smarts to RFC 2047 decode them before presenting
   the template to a user for editing.

Also, as far as I know, nothing automated consumes the reply text
format, so changing this should not cause serious problems.  (And if
anything does still consume this format, it probably gets these
encoding issues wrong anyway.)
2013-08-17 09:06:08 +02:00
David Bremner
48f2b3f1bc release: synchronize dates
man pages, NEWS, and debian changelog all hardcode date.  Make them
hardcode the same date.
2013-08-03 08:29:40 -03:00
David Bremner
80b25792b2 version: set new version and release date
These are manually set in version and NEWS, and propagate to the other files via
"make update-versions"
2013-07-28 11:28:03 -03:00
Peter Wang
d494271d79 man: document insert --create-folder
Add documentation for notmuch insert --create-folder option.
2013-07-04 00:07:48 -03:00
Peter Wang
9a5b129002 man: document insert --folder option
Add documentation for notmuch insert --folder option.
2013-07-01 12:22:57 -03:00
Peter Wang
1e690347a7 man: reference notmuch-insert.1
Add references to notmuch-insert.1 from other man pages.
2013-06-29 19:28:18 -03:00
Peter Wang
c8365d0995 man: document 'insert' command
Add initial documentation for notmuch insert command.
2013-06-29 14:42:50 -03:00
Tomi Ollila
8d863c9e87 revert: Removed top level --stderr= option
While looked good on paper, its attempted use caused confusion, complexity,
and potential for information leak when passed through wrapper scripts.
For slimmer code and to lessen demand for maintenance/support the set of
commits which added top level --stderr= option is now reverted.
2013-06-24 22:52:59 -07:00
Tomi Ollila
21eba9d686 man: documented --stderr=FILE in notmuch.1 manual page 2013-05-29 20:06:45 -03:00
Peter Wang
7e455bc920 man: document search --exclude=all
Document the new search --exclude=all option.
2013-05-13 21:33:01 -03:00
Peter Wang
c3ed770683 man: clarify search --exclude=flag
Improve the description of the search --exclude=flag option,
using text taken from the commit that introduced the option.
2013-05-12 07:44:42 -03:00
Peter Wang
ea0e75702d man: clarify search --exclude documentation
Highlight "excluded messages" as a term with a meaning that
may not be obvious.

Be explicit about the effects of search --exclude=true and
--exclude=false.
2013-05-12 07:44:27 -03:00
David Bremner
3c5ada48be man: document NOTMUCH_DEBUG_QUERY
This is is really functionality of the library, but CLI users might
not look at library docs even if they existed beyond notmuch.h
2013-04-30 06:13:05 -03:00
Jani Nikula
1abd795677 man: document notmuch count --batch and --input options 2013-04-01 09:38:32 -04:00
Jani Nikula
26105ddbb0 man: document notmuch tag --remove-all 2013-03-30 18:34:10 -04:00
Jani Nikula
6daee9b082 man: document the notmuch --config=FILE global option 2013-03-08 07:55:04 -04:00
Jani Nikula
d6d3fa32f6 man: show and reply --decrypt option requires gpg-agent 2013-03-02 10:41:38 -04:00
David Bremner
16aa65ba25 Merge branch 'release'
add in NEWS from 0.15.2

Conflicts:
	NEWS
2013-02-18 20:33:48 -04:00
David Bremner
bcccc2e1fe bump versions to 0.15.2 2013-02-17 11:39:46 -04:00
David Bremner
8fc5f3b666 man: document NOTMUCH_TALLOC_REPORT environment variable 2013-02-08 21:59:53 -04:00
David Bremner
7264732a79 Merge branch 'release'
Conflicts:
	NEWS

Inserted news from 0.15.1
2013-01-24 22:29:09 -04:00
David Bremner
d273ed6cf1 version: bump to 0.15.1
A simple bugfix release, no user visible changes
2013-01-24 07:11:27 -04:00
David Bremner
3d19e6f1fd man: document existing top level options
The options --help and --version were not documented before.  One
could quibble about how useful that documentation is, but we will soon
add more options.
2013-01-22 21:19:35 -04:00
David Bremner
df9f50185c version: update to 0.15
Bump the version in-place in NEWS.
2013-01-18 21:27:57 -04:00
David Bremner
81866a82ad version: set version to 0.15~rc1
This is in some sense a rollback, but it makes all the automation
happier if the Debian and upstream versions match.
2013-01-16 23:23:00 -04:00
Jani Nikula
e43e0af920 man: tag changes are applied in the order they are specified in notmuch tag 2013-01-10 08:15:23 -04:00
David Bremner
37be45767f version: bump to 0.15
"Atomically" update the python bindings and man page versions.
2013-01-07 21:38:20 -04:00
Jani Nikula
4068dc2b9d man: document notmuch tag --batch, --input options 2013-01-07 20:49:00 -04:00
Austin Clements
c31a91bc5c man: Update notmuch-dump(1) and notmuch-restore(1)
Describe the new batch-tag format.  For notmuch-restore, rather than
half-heartedly duplicating the description, we now cite notmuch-dump.
2013-01-06 22:40:45 -04:00
David Bremner
5a1b22e2bc notmuch-tag.1: tidy synopsis formatting, reference
Consistently use [...]; one less space. Use singular <search-term>
2012-12-26 09:45:08 -04:00
Jani Nikula
22ebd9aa24 man: document notmuch search --format=text0 2012-12-18 17:04:29 -04:00
Austin Clements
f6adf6615c reply: Support --format-version 2012-12-16 17:21:32 -04:00
Austin Clements
aecff2c9fd show: Support --format-version 2012-12-16 17:21:00 -04:00
Austin Clements
3152cf4b12 search: Support --format-version 2012-12-16 17:20:43 -04:00
David Bremner
60cd3b9a06 notmuch-{dump,restore}.1: document new format options
More or less arbitrarily, notmuch-dump.1 gets the more detailed
description of the format.
2012-12-09 13:33:34 -04:00
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