From 2134d331154dfbe8d01b8db310f8d5ad7616f38d Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Tue, 21 Aug 2012 12:40:58 +0300 Subject: [PATCH] manpages (for 0.14) update --- manpages.mdwn | 2 +- manpages/notmuch-1.mdwn | 2 +- manpages/notmuch-config-1.mdwn | 2 +- manpages/notmuch-count-1.mdwn | 2 +- manpages/notmuch-dump-1.mdwn | 21 +++--- manpages/notmuch-hooks-5.mdwn | 2 +- manpages/notmuch-new-1.mdwn | 2 +- manpages/notmuch-reply-1.mdwn | 2 +- manpages/notmuch-restore-1.mdwn | 4 +- manpages/notmuch-search-1.mdwn | 2 +- manpages/notmuch-search-terms-7.mdwn | 2 +- manpages/notmuch-setup-1.mdwn | 2 +- manpages/notmuch-show-1.mdwn | 103 +++++++++++++++------------ manpages/notmuch-tag-1.mdwn | 2 +- 14 files changed, 81 insertions(+), 69 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index 1c176e3..6bb01fa 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -9,7 +9,7 @@ Manual page index * notmuch-reply(1) - constructs a reply template for a set of messages * notmuch-restore(1) - restores the tags from the given file (see notmuch dump) * notmuch-search(1) - search for messages matching the given search terms -* notmuch-setup(1) - thread-based email index, search, and tagging +* notmuch-setup(1) - thread-based email index, search, and tagging * notmuch-show(1) - show messages matching the given search terms * notmuch-tag(1) - add/remove tags for all messages matching the search terms * notmuch-hooks(5) - hooks for notmuch diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 85cefc6..98d0d81 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -119,4 +119,4 @@ (server: irc.freenode.net, channel: #notmuch). -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index e5dfe37..e54a4f0 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -117,4 +117,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 5754a7e..b917808 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -48,4 +48,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index e1e70fb..92424b6 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -7,34 +7,33 @@

SYNOPSIS

-       notmuch dump [ <filename> ] [--] [ <search-term>...]
+       notmuch dump [ --output=<filename> ] [--] [ <search-term>...]

DESCRIPTION

        Dump tags for messages matching the given search terms.
 
-       Output is to the given filename, if any, or to stdout.  Note that using
-       the filename argument is deprecated.
+       Output is to the given filename, if any, or to stdout.
 
-       These tags are the only data in the  notmuch  database  that  can't  be
-       recreated  from the messages themselves.  The output of notmuch dump is
-       therefore the only critical thing to backup (and much more friendly  to
+       These  tags  are  the  only  data in the notmuch database that can't be
+       recreated from the messages themselves.  The output of notmuch dump  is
+       therefore  the only critical thing to backup (and much more friendly to
        incremental backup than the native database files.)
 
-       With  no  search  terms, a dump of all messages in the database will be
-       generated.  A "--" argument instructs notmuch that the remaining  argu-
+       With no search terms, a dump of all messages in the  database  will  be
+       generated.   A "--" argument instructs notmuch that the remaining argu-
        ments are search terms.
 
-       See  notmuch-search-terms(7)  for  details  of the supported syntax for
+       See notmuch-search-terms(7) for details of  the  supported  syntax  for
        <search-terms>.

SEE ALSO

        notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-hooks(5), not-
-       much-new(1),  notmuch-reply(1),  notmuch-restore(1), notmuch-search(1),
+       much-new(1), notmuch-reply(1),  notmuch-restore(1),  notmuch-search(1),
        notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
-

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 77436a1..207c29f 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -45,4 +45,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index e382d52..6977e21 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -50,4 +50,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 2dee7f8..9fe2795 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -89,4 +89,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index a62bf83..555ae6a 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -8,7 +8,7 @@

SYNOPSIS

-       notmuch restore [--accumulate] [ <filename> ]
+       notmuch restore [--accumulate] [ --input=<filename> ]

DESCRIPTION

@@ -41,4 +41,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 119b2ff..b042815 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -104,4 +104,4 @@ notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index d7fb66e..f7d047c 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -114,4 +114,4 @@ notmuch-search(1), notmuch-show(1), notmuch-tag(1) -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-setup-1.mdwn b/manpages/notmuch-setup-1.mdwn index 85cefc6..98d0d81 100644 --- a/manpages/notmuch-setup-1.mdwn +++ b/manpages/notmuch-setup-1.mdwn @@ -119,4 +119,4 @@ (server: irc.freenode.net, channel: #notmuch). -

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 168f94a..2cbeff9 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -25,59 +25,62 @@ Supported options for show include - --entire-thread + --entire-thread=(true|false) - By default only those messages that match the search terms will - be displayed. With this option, all messages in the same thread - as any matched message will be displayed. + If true, notmuch show outputs all messages in the thread of any + message matching the search terms; if false, it outputs only + the matching messages. For --format=json this defaults to true. + For other formats, this defaults to false. --format=(text|json|mbox|raw) text (default for messages) - The default plain-text format has all text-content MIME - parts decoded. Various components in the output, (message, + The default plain-text format has all text-content MIME + parts decoded. Various components in the output, (message, header, body, attachment, and MIME part), will be delimited - by easily-parsed markers. Each marker consists of a Con- - trol-L character (ASCII decimal 12), the name of the - marker, and then either an opening or closing brace, ('{' - or '}'), to either open or close the component. For a mul- + by easily-parsed markers. Each marker consists of a Con- + trol-L character (ASCII decimal 12), the name of the + marker, and then either an opening or closing brace, ('{' + or '}'), to either open or close the component. For a mul- tipart MIME message, these parts will be nested. json - The output is formatted with Javascript Object Notation + The output is formatted with Javascript Object Notation (JSON). This format is more robust than the text format for - automated processing. The nested structure of multipart - MIME messages is reflected in nested JSON output. JSON out- - put always includes all messages in a matching thread; in - effect --format=json implies --entire-thread + automated processing. The nested structure of multipart + MIME messages is reflected in nested JSON output. By + default JSON output includes all messages in a matching + thread; that is, by default, --format=json sets + --entire-thread The caller can disable this behaviour by + setting --entire-thread=false mbox - All matching messages are output in the traditional, Unix - mbox format with each message being prefixed by a line - beginning with "From " and a blank line separating each - message. Lines in the message content beginning with "From - " (preceded by zero or more '>' characters) have an addi- - tional '>' character added. This reversible escaping is + All matching messages are output in the traditional, Unix + mbox format with each message being prefixed by a line + beginning with "From " and a blank line separating each + message. Lines in the message content beginning with "From + " (preceded by zero or more '>' characters) have an + additional '>' character added. This reversible escaping is termed "mboxrd" format and described in detail here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html raw (default for a single part, see --part) - For a message or an attached message part, the original, - raw content of the email message is output. Consumers of - this format should expect to implement MIME decoding and + For a message or an attached message part, the original, + raw content of the email message is output. Consumers of + this format should expect to implement MIME decoding and similar functions. - For a single part (--part) the raw part content is output - after performing any necessary MIME decoding. Note that + For a single part (--part) the raw part content is output + after performing any necessary MIME decoding. Note that messages with a simple body still have two parts: part 0 is the whole message and part 1 is the body. - For a multipart part, the part headers and body (including + For a multipart part, the part headers and body (including all child parts) is output. The raw format must only be used with search terms matching @@ -86,52 +89,62 @@ --part=N Output the single decoded MIME part N of a single message. The - search terms must match only a single message. Message parts - are numbered in a depth-first walk of the message MIME struc- - ture, and are identified in the 'json' or 'text' output for- + search terms must match only a single message. Message parts + are numbered in a depth-first walk of the message MIME struc- + ture, and are identified in the 'json' or 'text' output for- mats. --verify - Compute and report the validity of any MIME cryptographic sig- - natures found in the selected content (ie. "multipart/signed" + Compute and report the validity of any MIME cryptographic sig- + natures found in the selected content (ie. "multipart/signed" parts). Status of the signature will be reported (currently on- ly supported with --format=json), and the multipart/signed part will be replaced by the signed data. --decrypt - Decrypt any MIME encrypted parts found in the selected content - (ie. "multipart/encrypted" parts). Status of the decryption - will be reported (currently only supported with --format=json) - and the multipart/encrypted part will be replaced by the de- + Decrypt any MIME encrypted parts found in the selected content + (ie. "multipart/encrypted" parts). Status of the decryption + will be reported (currently only supported with --format=json) + and the multipart/encrypted part will be replaced by the de- crypted content. Implies --verify. --exclude=(true|false) - Specify whether to omit threads only matching search.tag_ex- - clude from the search results (the default) or not. In either - case the excluded message will be marked with the exclude flag - (except when output=mbox when there is nowhere to put the + Specify whether to omit threads only matching search.tag_ex- + clude from the search results (the default) or not. In either + case the excluded message will be marked with the exclude flag + (except when output=mbox when there is nowhere to put the flag). - If --entire-thread is specified then complete threads are re- + If --entire-thread is specified then complete threads are re- turned regardless (with the excluded flag being set when appro- - priate) but threads that only match in an excluded message are + priate) but threads that only match in an excluded message are not returned when --exclude=true. The default is --exclude=true. - A common use of notmuch show is to display a single thread of email + --body=(true|false) + + If true (the default) notmuch show includes the bodies of the + messages in the output; if false, bodies are omitted. + --body=false is only implemented for the json format and it is + incompatible with --part >&gt; 0. + + This is useful if the caller only needs the headers as body- + less output is much faster and substantially smaller. + + A common use of notmuch show is to display a single thread of email messages. For this, use a search term of "thread:<thread-id>" as can be seen in the first column of output from the notmuch search command.

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not-
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not-
        much-hooks(5),  notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
        notmuch-search(1), notmuch-search-terms(7), notmuch-tag(1)
-

Notmuch 0.13.2

+

Notmuch 0.14

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 78368d9..eee0325 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -38,4 +38,4 @@ notmuch-search(1), notmuch-search-terms(7), notmuch-show(1), -

Notmuch 0.13.2

+

Notmuch 0.14

-- 2.43.0