diff options
| author | Tomi Ollila <tomi.ollila@iki.fi> | 2012-08-21 12:40:58 +0300 |
|---|---|---|
| committer | Tomi Ollila <tomi.ollila@iki.fi> | 2012-08-21 12:40:58 +0300 |
| commit | 2134d331154dfbe8d01b8db310f8d5ad7616f38d (patch) | |
| tree | 47012b37bdcba3e90567f6b1ed57a27eb40990d2 | |
| parent | 26fa0dfa0dcb85877b42bc384f8aa9cf682324a5 (diff) | |
manpages (for 0.14) update
| -rw-r--r-- | manpages.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-config-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-count-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-dump-1.mdwn | 21 | ||||
| -rw-r--r-- | manpages/notmuch-hooks-5.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-new-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-reply-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-restore-1.mdwn | 4 | ||||
| -rw-r--r-- | manpages/notmuch-search-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-search-terms-7.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-setup-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-show-1.mdwn | 103 | ||||
| -rw-r--r-- | 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 * <a href='notmuch-reply-1/'>notmuch-reply</a>(1) - constructs a reply template for a set of messages * <a href='notmuch-restore-1/'>notmuch-restore</a>(1) - restores the tags from the given file (see notmuch dump) * <a href='notmuch-search-1/'>notmuch-search</a>(1) - search for messages matching the given search terms -* <a href='notmuch-1/'>notmuch-setup</a>(1) - thread-based email index, search, and tagging +* <a href='notmuch-setup-1/'>notmuch-setup</a>(1) - thread-based email index, search, and tagging * <a href='notmuch-show-1/'>notmuch-show</a>(1) - show messages matching the given search terms * <a href='notmuch-tag-1/'>notmuch-tag</a>(1) - add/remove tags for all messages matching the search terms * <a href='notmuch-hooks-5/'>notmuch-hooks</a>(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). </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <h2>SYNOPSIS</h2> <pre> - <b>notmuch</b> <b>dump</b> [ <<u>filename</u>> ] [--] [ <<u>search-term</u>>...] + <b>notmuch</b> <b>dump</b> [ --output=<<u>filename</u>> ] [--] [ <<u>search-term</u>>...] </pre> <h2>DESCRIPTION</h2> <pre> 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 <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for + See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for <search-terms>. </pre> <h2>SEE ALSO</h2> <pre> <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-new-1/'>not-</a> - <a href='../notmuch-new-1/'>much-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), + <a href='../notmuch-new-1/'>much-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <h2>SYNOPSIS</h2> <pre> - <b>notmuch</b> <b>restore</b> [<b>--accumulate</b>] [ <<u>filename</u>> ] + <b>notmuch</b> <b>restore</b> [<b>--accumulate</b>] [ --input=<<u>filename</u>> ] </pre> <h2>DESCRIPTION</h2> @@ -41,4 +41,4 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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). </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 <b>show</b> include - <b>--entire-thread</b> + <b>--entire-thread=(true|false)</b> - 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, <b>notmuch</b> <b>show</b> outputs all messages in the thread of any + message matching the search terms; if false, it outputs only + the matching messages. For <b>--format=json</b> this defaults to true. + For other formats, this defaults to false. <b>--format=(text|json|mbox|raw)</b> <b>text</b> (default for messages) - The default plain-text format has all text-content MIME - parts decoded. Various components in the output, (<b>message</b>, + The default plain-text format has all text-content MIME + parts decoded. Various components in the output, (<b>message</b>, <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), 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. <b>json</b> - 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 <b>--format=json</b> implies <b>--entire-thread</b> + 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, <b>--format=json</b> sets + <b>--entire-thread</b> The caller can disable this behaviour by + setting <b>--entire-thread=false</b> <b>mbox</b> - 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 <b>raw</b> (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 @@ <b>--part=N</b> 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. <b>--verify</b> - 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. <b>--decrypt</b> - 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. <b>--exclude=(true|false)</b> - 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 <b>--exclude=true.</b> The default is <b>--exclude=true.</b> - A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email + <b>--body=(true|false)</b> + + If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the + messages in the output; if false, bodies are omitted. + <b>--body=false</b> is only implemented for the json format and it is + incompatible with <b>--part</b> ><b>&</b>gt; <b>0.</b> + + This is useful if the caller only needs the headers as body- + less output is much faster and substantially smaller. + + A common use of <b>notmuch</b> <b>show</b> 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 <b>notmuch</b> <b>search</b> command. </pre> <h2>SEE ALSO</h2> <pre> - <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a> + <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a> <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> 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 @@ <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), </pre> -<h2>Notmuch 0.13.2</h2> +<h2>Notmuch 0.14</h2> |