From: Tomi Ollila Date: Sat, 15 Nov 2014 13:58:39 +0000 (+0200) Subject: manual pages for 0.19 (sans api page, for now) X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=commitdiff_plain;h=cf2df983cb6d13042694366be4aba76d4a98048b manual pages for 0.19 (sans api page, for now) --- 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 ================= * notmuch(1) - thread-based email index, search, and tagging +* notmuch-address(1) - output addresses from matching messages * notmuch-compact(1) - compact the notmuch database * notmuch-config(1) - access notmuch configuration file * notmuch-count(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 notmuch-search-terms(7) for more details on the supported syn‐ tax. - The search, show and count commands are used to query the email data‐ - base. + The search, show, address and count commands are used to query the + email database. The reply command is useful for preparing a template for an email reply. @@ -127,7 +127,7 @@ notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), not‐ much-restore(1), notmuch-search(1), notmuch-search-terms(7), not‐ - much-show(1), notmuch-tag(1) + much-show(1), notmuch-tag(1), notmuch-address(1) The notmuch website: http://notmuchmail.org @@ -152,4 +152,4 @@ 2014, Carl Worth and many others -

0.18.1

+

0.19

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 @@ +

NOTMUCH-ADDRESS(1)

+ +

NAME

+
+       notmuch-address - output addresses from matching messages
+
+ +

SYNOPSIS

+
+       notmuch address [option ...] <search-term> ...
+
+ +

DESCRIPTION

+
+       Search  for  messages  matching the given search terms, and display the
+       addresses from them. Duplicate addresses are filtered out.
+
+       See notmuch-search-terms(7) for details of  the  supported  syntax  for
+       <search-terms>.
+
+       Supported options for address include
+
+          --format=(json|sexp|text|text0)
+                 Presents  the  results in either JSON, S-Expressions, newline
+                 character separated plain-text (default), or  null  character
+                 separated  plain-text  (compatible  with  xargs(1)  -0 option
+                 where available).
+
+          --format-version=N
+                 Use the specified structured output format version.  This  is
+                 intended  for  programs that invoke notmuch(1) internally. If
+                 omitted, the latest supported version will be used.
+
+          --output=(sender|recipients|count)
+              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.
+
+              sender Output all addresses from the From header.
+
+                     Note:  Searching  for  sender  should be much faster than
+                     searching for recipients, because  sender  addresses  are
+                     cached  directly  in the database whereas other addresses
+                     need to be fetched from message files.
+
+              recipients
+                     Output all addresses from the To, Cc and Bcc headers.
+
+              count  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.
+
+          --sort=(newest-first|oldest-first)
+                 This option can be used to present results in either  chrono‐
+                 logical  order  (oldest-first) or reverse chronological order
+                 (newest-first).
+
+                 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.
+
+          --exclude=(true|false)
+                 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,  true,  prevents  excluded messages from
+                 matching the search terms.
+
+                 false allows excluded messages  to  match  search  terms  and
+                 appear in displayed results.
+
+ +

EXIT STATUS

+
+       This command supports the following special exit status codes
+
+       20     The requested format version is too old.
+
+       21     The requested format version is too new.
+
+ +

SEE ALSO

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

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
+
+ +

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 @@

SYNOPSIS

-          $DATABASEDIR/.notmuch/hooks/*
+       $DATABASEDIR/.notmuch/hooks/*

DESCRIPTION

@@ -36,12 +36,22 @@ Typically this hook is used to perform additional query-based tagging on the imported messages. + + post-insert + This hook is invoked by the insert 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 --keep option. + + Typically this hook is used to perform additional query-based + tagging on the delivered messages.

SEE ALSO

-       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
-       much-insert(1),  notmuch-new(1),  notmuch-reply(1), notmuch-restore(1),
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       much-insert(1), notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
        notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -56,4 +66,4 @@ 2014, Carl Worth and many others -

0.18.1

+

0.19

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 insert command supports hooks. See notmuch-hooks(5) for more + details on hooks. + + Option arguments must appear before any tag operation arguments. Sup‐ ported options for insert include --folder=<folder> - Deliver the message to the specified folder, relative to the - top-level directory given by the value of database.path. The + Deliver the message to the specified folder, relative to the + top-level directory given by the value of database.path. The default is to deliver to the top-level directory. --create-folder - Try to create the folder named by the --folder option, if it - does not exist. Otherwise the folder must already exist for + Try to create the folder named by the --folder option, if it + does not exist. Otherwise the folder must already exist for mail delivery to succeed. + + --keep 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. + + --no-hooks + Prevent hooks from being run.

EXIT STATUS

-       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 --keep 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 post-insert hook does not affect the exit status
+       of the insert command.

SEE ALSO

@@ -68,4 +81,4 @@ 2014, Carl Worth and many others -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 notmuch(1) internally. If omitted, the latest supported version will be used. - --output=(summary|threads|messages|files|tags) + --output=(summary|threads|messages|files|tags|sender|recipients) summary Output a summary of each thread with any message matching @@ -125,10 +125,14 @@ than the number of matching messages. --duplicate=N - Effective with --output=files, 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 --output=files, 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 --output=messages, 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 folder: search prefix. The prefix matches messages based on filenames. This @@ -149,7 +153,7 @@ notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐ much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1), notmuch-search-terms(7), notmuch-show(1), not‐ - much-tag(1) + much-tag(1) notmuch-address(1)

AUTHOR

@@ -162,4 +166,4 @@ 2014, Carl Worth and many others -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19

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 -

0.18.1

+

0.19