diff options
| author | Tomi Ollila <tomi.ollila@iki.fi> | 2014-11-15 15:58:39 +0200 |
|---|---|---|
| committer | Tomi Ollila <tomi.ollila@iki.fi> | 2014-11-15 15:58:39 +0200 |
| commit | cf2df983cb6d13042694366be4aba76d4a98048b (patch) | |
| tree | 7792e76881bd8715dd3b3e430f375e9e1ba5c2f1 | |
| parent | e8935ee4bb3f321482fc1861647c9431fde53361 (diff) | |
manual pages for 0.19 (sans api page, for now)
| -rw-r--r-- | manpages.mdwn | 1 | ||||
| -rw-r--r-- | manpages/notmuch-1.mdwn | 8 | ||||
| -rw-r--r-- | manpages/notmuch-address-1.mdwn | 107 | ||||
| -rw-r--r-- | manpages/notmuch-compact-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 | 2 | ||||
| -rw-r--r-- | manpages/notmuch-hooks-5.mdwn | 18 | ||||
| -rw-r--r-- | manpages/notmuch-insert-1.mdwn | 37 | ||||
| -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 | 2 | ||||
| -rw-r--r-- | manpages/notmuch-search-1.mdwn | 18 | ||||
| -rw-r--r-- | manpages/notmuch-search-terms-7.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-show-1.mdwn | 2 | ||||
| -rw-r--r-- | manpages/notmuch-tag-1.mdwn | 2 |
16 files changed, 172 insertions, 37 deletions
diff --git a/manpages.mdwn b/manpages.mdwn index 16ac3ea..1439d7e 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -2,6 +2,7 @@ Manual page index ================= * <a href='notmuch-1/'>notmuch</a>(1) - thread-based email index, search, and tagging +* <a href='notmuch-address-1/'>notmuch-address</a>(1) - output addresses from matching messages * <a href='notmuch-compact-1/'>notmuch-compact</a>(1) - compact the notmuch database * <a href='notmuch-config-1/'>notmuch-config</a>(1) - access notmuch configuration file * <a href='notmuch-count-1/'>notmuch-count</a>(1) - count messages matching the given search terms diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 5a276e5..79ca06b 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -87,8 +87,8 @@ tax. See <b>notmuch-search-terms</b>(7) for more details on the supported syn‐ tax. - The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email data‐ - base. + The <b>search</b>, <b>show</b>, <b>address</b> and <b>count</b> commands are used to query the + email database. The <b>reply</b> command is useful for preparing a template for an email reply. @@ -127,7 +127,7 @@ <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/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>not‐</a> <a href='../notmuch-restore-1/'>much-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/'>not‐</a> - <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) + <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1), <a href='../notmuch-address-1/'>notmuch-address</a>(1) The notmuch website: <b>http://notmuchmail.org</b> </pre> @@ -152,4 +152,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn new file mode 100644 index 0000000..c0165ae --- /dev/null +++ b/manpages/notmuch-address-1.mdwn @@ -0,0 +1,107 @@ +<h1>NOTMUCH-ADDRESS(1)</h1> + +<h2>NAME</h2> +<pre> + notmuch-address - output addresses from matching messages +</pre> + +<h2>SYNOPSIS</h2> +<pre> + <b>notmuch</b> <b>address</b> [<u>option</u> ...] <<u>search-term</u>> ... +</pre> + +<h2>DESCRIPTION</h2> +<pre> + Search for messages matching the given search terms, and display the + addresses from them. Duplicate addresses are filtered out. + + See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for + <search-terms>. + + Supported options for <b>address</b> include + + <b>--format=(json|sexp|text|text0)</b> + Presents the results in either JSON, S-Expressions, newline + character separated plain-text (default), or null character + separated plain-text (compatible with <b>xargs</b>(1) -0 option + where available). + + <b>--format-version=N</b> + Use the specified structured output format version. This is + intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If + omitted, the latest supported version will be used. + + <b>--output=(sender|recipients|count)</b> + Controls which information appears in the output. This option + can be given multiple times to combine different outputs. When + neither --output=sender nor --output=recipients is given, --out‐ + put=sender is implied. + + <b>sender</b> Output all addresses from the <u>From</u> header. + + Note: Searching for <b>sender</b> should be much faster than + searching for <b>recipients</b>, because sender addresses are + cached directly in the database whereas other addresses + need to be fetched from message files. + + <b>recipients</b> + Output all addresses from the <u>To</u>, <u>Cc</u> and <u>Bcc</u> headers. + + <b>count</b> Print the count of how many times was the address encoun‐ + tered during search. + + Note: With this option, addresses are printed only after + the whole search is finished. This may take long time. + + <b>--sort=(newest-first|oldest-first)</b> + This option can be used to present results in either chrono‐ + logical order (<b>oldest-first</b>) or reverse chronological order + (<b>newest-first</b>). + + By default, results will be displayed in reverse chronologi‐ + cal order, (that is, the newest results will be displayed + first). + + This option is not supported with --output=count. + + <b>--exclude=(true|false)</b> + A message is called "excluded" if it matches at least one tag + in search.tag_exclude that does not appear explicitly in the + search terms. This option specifies whether to omit excluded + messages in the search process. + + The default value, <b>true</b>, prevents excluded messages from + matching the search terms. + + <b>false</b> allows excluded messages to match search terms and + appear in displayed results. +</pre> + +<h2>EXIT STATUS</h2> +<pre> + This command supports the following special exit status codes + + <b>20</b> The requested format version is too old. + + <b>21</b> The requested format version is too new. +</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-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <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-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a> + <a href='../notmuch-tag-1/'>much-tag</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1) +</pre> + +<h2>AUTHOR</h2> +<pre> + Carl Worth and many others +</pre> + +<h2>COPYRIGHT</h2> +<pre> + 2014, Carl Worth and many others +</pre> + +<h2>0.19</h2> diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index 7bbda19..bffcc5d 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -64,4 +64,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 1b1235f..25d4ad0 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -135,4 +135,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 1eb513d..a6810d4 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -72,4 +72,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 2caf278..00d8ef1 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -86,4 +86,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 873fd90..be98dde 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -7,7 +7,7 @@ <h2>SYNOPSIS</h2> <pre> - $DATABASEDIR/.notmuch/hooks/* + $DATABASEDIR/.notmuch/hooks/* </pre> <h2>DESCRIPTION</h2> @@ -36,12 +36,22 @@ Typically this hook is used to perform additional query-based tagging on the imported messages. + + <b>post-insert</b> + This hook is invoked by the <b>insert</b> command after the message has + been delivered, added to the database, and initial tags have + been applied. The hook will not be run if there have been any + errors during the message delivery; what is regarded as succes‐ + ful delivery depends on the <b>--keep</b> option. + + Typically this hook is used to perform additional query-based + tagging on the delivered messages. </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-insert-1/'>not‐</a> - <a href='../notmuch-insert-1/'>much-insert</a>(1), <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-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-insert-1/'>not‐</a> + <a href='../notmuch-insert-1/'>much-insert</a>(1), <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-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a> <a href='../notmuch-tag-1/'>much-tag</a>(1) </pre> @@ -56,4 +66,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index fdaa55a..56a2b2a 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -26,29 +26,42 @@ base (it has same Message-ID), it will be added to the maildir folder and notmuch database, but the tags will not be changed. - Option arguments must appear before any tag operation arguments. Sup‐ + The <b>insert</b> command supports hooks. See <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5) for more + details on hooks. + + Option arguments must appear before any tag operation arguments. Sup‐ ported options for <b>insert</b> include <b>--folder=<folder></b> - Deliver the message to the specified folder, relative to the - top-level directory given by the value of <b>database.path</b>. The + Deliver the message to the specified folder, relative to the + top-level directory given by the value of <b>database.path</b>. The default is to deliver to the top-level directory. <b>--create-folder</b> - Try to create the folder named by the <b>--folder</b> option, if it - does not exist. Otherwise the folder must already exist for + Try to create the folder named by the <b>--folder</b> option, if it + does not exist. Otherwise the folder must already exist for mail delivery to succeed. + + <b>--keep</b> Keep the message file if indexing fails, and keep the message + indexed if applying tags or maildir flag synchronization + fails. Ignore these errors and return exit status 0 to indi‐ + cate succesful mail delivery. + + <b>--no-hooks</b> + Prevent hooks from being run. </pre> <h2>EXIT STATUS</h2> <pre> - This command returns exit status 0 if the message was successfully - added to the mail directory, even if the message could not be indexed - and added to the notmuch database. In the latter case, a warning will - be printed to standard error but the message file will be left on disk. + This command returns exit status 0 on succesful mail delivery, non-zero + otherwise. The default is to indicate failed mail delivery on any + errors, including message file delivery to the filesystem, message + indexing to Notmuch database, changing tags, and synchronizing tags to + maildir flags. The <b>--keep</b> option may be used to settle for successful + message file delivery. - If the message could not be written to disk then a non-zero exit status - is returned. + The exit status of the <b>post-insert</b> hook does not affect the exit status + of the <b>insert</b> command. </pre> <h2>SEE ALSO</h2> @@ -68,4 +81,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index e17a0d0..2366fa2 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -63,4 +63,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 0649d23..79ef1ff 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -119,4 +119,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 225affc..d9546bc 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -80,4 +80,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 53bdbb7..c6f9361 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -37,7 +37,7 @@ intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If omitted, the latest supported version will be used. - <b>--output=(summary|threads|messages|files|tags)</b> + <b>--output=(summary|threads|messages|files|tags|sender|recipients)</b> <b>summary</b> Output a summary of each thread with any message matching @@ -125,10 +125,14 @@ than the number of matching messages. <b>--duplicate=N</b> - Effective with <b>--output=files</b>, output the Nth filename asso‐ - ciated with each message matching the query (N is 1-based). - If N is greater than the number of files associated with the - message, don't print anything. + For <b>--output=files</b>, output the Nth filename associated with + each message matching the query (N is 1-based). If N is + greater than the number of files associated with the message, + don't print anything. + + For <b>--output=messages</b>, only output message IDs of messages + matching the search terms that have at least N filenames + associated with them. Note that this option is orthogonal with the <b>folder:</b> search prefix. The prefix matches messages based on filenames. This @@ -149,7 +153,7 @@ <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-insert-1/'>notmuch-insert</a>(1), <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-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a> - <a href='../notmuch-tag-1/'>much-tag</a>(1) + <a href='../notmuch-tag-1/'>much-tag</a>(1) <a href='../notmuch-address-1/'>notmuch-address</a>(1) </pre> <h2>AUTHOR</h2> @@ -162,4 +166,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index 61539a6..ee5c1b2 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -260,4 +260,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 001f9e5..7e077a7 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -188,4 +188,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 19c2775..dea0564 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -117,4 +117,4 @@ 2014, Carl Worth and many others </pre> -<h2>0.18.1</h2> +<h2>0.19</h2> |
