From: Tomi Ollila Date: Mon, 13 Mar 2017 19:17:10 +0000 (+0200) Subject: manpages for 0.24 X-Git-Url: https://git.notmuchmail.org/git?p=notmuch-wiki;a=commitdiff_plain;h=46b88668029f0f014c4ecf7a220b7a99a13776f3 manpages for 0.24 --- diff --git a/manpages.mdwn b/manpages.mdwn index 88c9145..96d1581 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -7,6 +7,7 @@ Manual page index * notmuch-config(1) - access notmuch configuration file * notmuch-count(1) - count messages matching the given search terms * notmuch-dump(1) - creates a plain-text dump of the tags of each message +* notmuch-emacs-mua(1) - send mail with notmuch and emacs * notmuch-insert(1) - add a message to the maildir and notmuch database * notmuch-new(1) - incorporate new mail into the notmuch database * notmuch-reply(1) - constructs a reply template for a set of messages @@ -21,4 +22,4 @@ The manual pages are licensed under [the GNU General Public License](https://www.gnu.org/licenses/gpl.txt), either version 3.0 or at your option any later version. -

0.23.4

+

0.24

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 6329f78..da44ca9 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -74,7 +74,7 @@ The setup command will prompt for your full name, your primary email address, any alternate email addresses you use, and the directory con‐ taining your email archives. Your answers will be written to a configu‐ - ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config. + ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config . This configuration file will be created with descriptive comments, mak‐ ing it easy to edit by hand later to change the configuration. Or you can run notmuch setup again to change the configuration. @@ -88,7 +88,7 @@ Mail storage that uses mbox format, (where one mbox file contains many messages), will not work with notmuch. If that's how your mail is cur‐ rently stored, it is recommended you first convert it to maildir format - with a utility such as mb2md before running notmuch setup. + with a utility such as mb2md before running notmuch setup . Invoking notmuch with no command argument will run setup if the setup command has not previously been completed. @@ -116,6 +116,15 @@ configuration file. +

  CUSTOM COMMANDS

+
+       If the given command is not known to notmuch, notmuch tries to  execute
+       the external notmuch-<subcommand> in ${PATH} instead. This allows users
+       to have their own notmuch related tools to be run via the notmuch  com‐
+       mand. By design, this does not allow notmuch's own commands to be over‐
+       riden using external commands.
+
+

ENVIRONMENT

        The following environment variables can be used to control the behavior
@@ -163,7 +172,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn
index e2c2f09..716adf6 100644
--- a/manpages/notmuch-address-1.mdwn
+++ b/manpages/notmuch-address-1.mdwn
@@ -123,7 +123,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn
index b71f79f..0aaf74e 100644
--- a/manpages/notmuch-compact-1.mdwn
+++ b/manpages/notmuch-compact-1.mdwn
@@ -61,7 +61,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn
index c41afea..b4eed69 100644
--- a/manpages/notmuch-config-1.mdwn
+++ b/manpages/notmuch-config-1.mdwn
@@ -166,7 +166,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn
index 2fc9f7d..bdfe013 100644
--- a/manpages/notmuch-count-1.mdwn
+++ b/manpages/notmuch-count-1.mdwn
@@ -74,7 +74,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn
index 976b58c..00239be 100644
--- a/manpages/notmuch-dump-1.mdwn
+++ b/manpages/notmuch-dump-1.mdwn
@@ -114,7 +114,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn
new file mode 100644
index 0000000..4c494bb
--- /dev/null
+++ b/manpages/notmuch-emacs-mua-1.mdwn
@@ -0,0 +1,98 @@
+
NOTMUCH-EMACS-MUA(1)

+
+
NAME

+
+       notmuch-emacs-mua - send mail with notmuch and emacs
+

+
+
SYNOPSIS

+
+       notmuch emacs-mua [options ...] [<to-address> ... | <mailto-url>]
+

+
+
DESCRIPTION

+
+       Start  composing  an  email  in the Notmuch Emacs UI with the specified
+       subject, recipients, and message body, or mailto: URL.
+
+       Supported options for emacs-mua include
+
+          -h, --help
+                 Display help.
+
+          -s, --subject=<subject>
+                 Specify the subject of the message.
+
+          --to=<to-address>
+                 Specify a recipient (To).
+
+          -c, --cc=<cc-address>
+                 Specify a carbon-copy (Cc) recipient.
+
+          -b, --bcc=<bcc-address>
+                 Specify a blind-carbon-copy (Bcc) recipient.
+
+          -i, --body=<file>
+                 Specify a file to include into the body of the message.
+
+          --hello
+                 Go to the Notmuch hello screen instead of the message  compo‐
+                 sition window if no message composition parameters are given.
+
+          --no-window-system
+                 Even  if a window system is available, use the current termi‐
+                 nal.
+
+          --client
+                 Use emacsclient, rather than emacs. For emacsclient to  work,
+                 you  need  an  already  running  Emacs  with a server, or use
+                 --auto-daemon.
+
+          --auto-daemon
+                 Automatically start Emacs in daemon mode, if the Emacs server
+                 is  not  running.  Applicable  with  --client. Implies --cre-
+                 ate-frame.
+
+          --create-frame
+                 Create a new frame instead of trying to use the current Emacs
+                 frame.  Applicable  with --client. This will be required when
+                 Emacs is running (or automatically started  with  --auto-dae-
+                 mon) in daemon mode.
+
+          --print
+                 Output  the  resulting  elisp to stdout instead of evaluating
+                 it.
+
+       The supported positional parameters and short options are a  compatible
+       subset of the mutt MUA command-line options. The options and positional
+       parameters modifying the message can't be  combined  with  the  mailto:
+       URL.
+
+       Options may be specified multiple times.
+

+
+
ENVIRONMENT VARIABLES

+
+       EMACS  Name of emacs command to invoke. Defaults to "emacs".
+
+       EMACSCLIENT
+              Name  of  emacsclient  command  to  invoke.  Defaults  to "emac‐
+              sclient".
+

+
+
SEE ALSO

+
+       notmuch(1), emacsclient(1), mutt(1)
+

+
+
AUTHOR

+
+       Carl Worth and many others
+

+
+
COPYRIGHT

+
+       2009-2017, Carl Worth and many others
+

+
+
0.24

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn
index 2ca871b..fbcbe3b 100644
--- a/manpages/notmuch-hooks-5.mdwn
+++ b/manpages/notmuch-hooks-5.mdwn
@@ -63,7 +63,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
index 243f416..329ebc2 100644
--- a/manpages/notmuch-insert-1.mdwn
+++ b/manpages/notmuch-insert-1.mdwn
@@ -85,7 +85,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn
index 4d6b123..ffe641f 100644
--- a/manpages/notmuch-new-1.mdwn
+++ b/manpages/notmuch-new-1.mdwn
@@ -68,7 +68,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn
index 2942990..83010f2 100644
--- a/manpages/notmuch-reply-1.mdwn
+++ b/manpages/notmuch-reply-1.mdwn
@@ -117,7 +117,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn
index f477b57..c0f1782 100644
--- a/manpages/notmuch-restore-1.mdwn
+++ b/manpages/notmuch-restore-1.mdwn
@@ -101,7 +101,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn
index 5659edc..66ff87c 100644
--- a/manpages/notmuch-search-1.mdwn
+++ b/manpages/notmuch-search-1.mdwn
@@ -163,7 +163,7 @@
 
 
COPYRIGHT

 
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 

 
-
0.23.4

+
0.24

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn
index 40b082d..f92b7c4 100644
--- a/manpages/notmuch-search-terms-7.mdwn
+++ b/manpages/notmuch-search-terms-7.mdwn
@@ -37,10 +37,14 @@
 
        · from:<name-or-address>
 
+       · from:/<regex>/
+
        · to:<name-or-address>
 
        · subject:<word-or-quoted-phrase>
 
+       · subject:/<regex>/
+
        · attachment:<word>
 
        · mimetype:<word>
@@ -74,46 +78,53 @@
        including quotation marks around the phrase, immediately following sub-
        ject:.
 
+       If  notmuch is built with Xapian Field Processors (see below) the from:
+       and subject prefix can be also used to restrict the  results  to  those
+       whose  from/subject  value  matches a regular expression (see regex(7))
+       delimited with //.
+
+          notmuch search 'from:/bob@.*[.]example[.]com/'
+
        The attachment: prefix can be used to search for specific filenames (or
        extensions) of attachments to email messages.
 
-       The mimetype: prefix will be used to match text from the  content-types
+       The  mimetype: prefix will be used to match text from the content-types
        of MIME parts within email messages (as specified by the sender).
 
-       For  tag:  and is: valid tag values include inbox and unread by default
-       for new messages added by notmuch new as well as any other  tag  values
+       For tag: and is: valid tag values include inbox and unread  by  default
+       for  new  messages added by notmuch new as well as any other tag values
        added manually with notmuch tag.
 
-       For  id:, message ID values are the literal contents of the Message-ID:
+       For id:, message ID values are the literal contents of the  Message-ID:
        header of email messages, but without the '<', '>' delimiters.
 
-       The thread: prefix can be used with the thread ID values that are  gen‐
-       erated  internally  by  notmuch  (and do not appear in email messages).
-       These thread ID values can be seen in the first column of  output  from
+       The  thread: prefix can be used with the thread ID values that are gen‐
+       erated internally by notmuch (and do not  appear  in  email  messages).
+       These  thread  ID values can be seen in the first column of output from
        notmuch search
 
-       The  path:  prefix  searches  for email messages that are in particular
+       The path: prefix searches for email messages  that  are  in  particular
        directories within the mail store. The directory must be specified rel‐
-       ative  to  the  top-level  maildir  (and without the leading slash). By
-       default, path: matches messages in the specified  directory  only.  The
-       "/**"  suffix  can be used to match messages in the specified directory
-       and all its subdirectories recursively.  path:""  matches  messages  in
+       ative to the top-level maildir (and  without  the  leading  slash).  By
+       default,  path:  matches  messages in the specified directory only. The
+       "/**" suffix can be used to match messages in the  specified  directory
+       and  all  its  subdirectories recursively.  path:"" matches messages in
        the root of the mail store and, likewise, path:** matches all messages.
 
        The folder: prefix searches for email messages by maildir or MH folder.
-       For MH-style folders, this is equivalent to path:.  For  maildir,  this
+       For  MH-style  folders,  this is equivalent to path:. For maildir, this
        includes messages in the "new" and "cur" subdirectories. The exact syn‐
-       tax for  maildir  folders  depends  on  your  mail  configuration.  For
-       maildir++,  folder:""  matches  the  inbox folder (which is the root in
-       maildir++), other folder names always start with ".", and nested  fold‐
-       ers  are separated by "."s, such as folder:.classes.topology. For "file
+       tax  for  maildir  folders  depends  on  your  mail  configuration. For
+       maildir++, folder:"" matches the inbox folder (which  is  the  root  in
+       maildir++),  other folder names always start with ".", and nested fold‐
+       ers are separated by "."s, such as folder:.classes.topology. For  "file
        system" maildir, the inbox is typically folder:INBOX and nested folders
        are separated by slashes, such as folder:classes/topology.
 
-       Both  path: and folder: will find a message if any copy of that message
+       Both path: and folder: will find a message if any copy of that  message
        is in the specific directory/folder.
 
-       The date: prefix can be used to restrict the results to  only  messages
+       The  date:  prefix can be used to restrict the results to only messages
        within a particular time range (based on the Date: header) with a range
        syntax of:
 
@@ -126,44 +137,44 @@
 
        <initial-timestamp>..<final-timestamp>
 
-       Each  timestamp  is  a  number representing the number of seconds since
+       Each timestamp is a number representing the  number  of  seconds  since
        1970-01-01 00:00:00 UTC.
 
-       The lastmod: prefix can be used to restrict the result by the  database
+       The  lastmod: prefix can be used to restrict the result by the database
        revision  number  of  when  messages  were  last  modified  (tags  were
-       added/removed or filenames changed).  This is usually used in  conjunc‐
-       tion  with  the --uuid argument to notmuch search to find messages that
+       added/removed  or filenames changed).  This is usually used in conjunc‐
+       tion with the --uuid argument to notmuch search to find  messages  that
        have changed since an earlier query.
 
-       The query: prefix allows queries to refer to previously  saved  queries
-       added  with notmuch-config(1). Named queries are only available if not‐
+       The  query:  prefix allows queries to refer to previously saved queries
+       added with notmuch-config(1). Named queries are only available if  not‐
        much is built with Xapian Field Processors (see below).
 
-       The  property:  prefix  searches  for  messages   with   a   particular
-       <key>=<value>  property pair. Properties are used internally by notmuch
-       (and extensions) to add metadata  to  messages.  A  given  key  can  be
+       The   property:   prefix   searches  for  messages  with  a  particular
+       <key>=<value> property pair. Properties are used internally by  notmuch
+       (and  extensions)  to  add  metadata  to  messages.  A given key can be
        present on a given message with several different values.

  Operators

-       In  addition  to  individual terms, multiple terms can be combined with
-       Boolean operators (and, or, not, and xor). Each term in the query  will
-       be  implicitly  connected  by  a logical AND if no explicit operator is
-       provided (except that terms with a common  prefix  will  be  implicitly
-       combined  with  OR).   The  shorthand  '-<term>'  can  be used for 'not
+       In addition to individual terms, multiple terms can  be  combined  with
+       Boolean  operators (and, or, not, and xor). Each term in the query will
+       be implicitly connected by a logical AND if  no  explicit  operator  is
+       provided  (except  that  terms  with a common prefix will be implicitly
+       combined with OR).  The  shorthand  '-<term>'  can  be  used  for  'not
        <term>' but unfortunately this does not work at the start of an expres‐
-       sion.   Parentheses  can also be used to control the combination of the
+       sion.  Parentheses can also be used to control the combination  of  the
        Boolean operators, but will have to be protected from interpretation by
        the shell, (such as by putting quotation marks around any parenthesized
        expression).
 
-       In addition to the standard boolean operators, Xapian provides  several
+       In  addition to the standard boolean operators, Xapian provides several
        operators specific to text searching.
 
           notmuch search term1 NEAR term2
 
-       will  return  results  where  term1  is  within  10 words of term2. The
+       will return results where term1  is  within  10  words  of  term2.  The
        threshold can be set like this:
 
           notmuch search term1 NEAR/2 term2
@@ -173,7 +184,7 @@
           notmuch search term1 ADJ term2
 
        will return results where term1 is within 10 words of term2, but in the
-       same  order  as in the query. The threshold can be set the same as with
+       same order as in the query. The threshold can be set the same  as  with
        NEAR:
 
           notmuch search term1 ADJ/7 term2
@@ -187,34 +198,38 @@
           notmuch search details
           notmuch search detail
 
-       will all return identical results, because Xapian first  "reduces"  the
+       will  all  return identical results, because Xapian first "reduces" the
        term to the common stem (here 'detail') and then performs the search.
 
-       There  are  two  ways to turn this off: a search for a capitalized word
-       will be performed unstemmed, so that one can search for "John" and  not
-       get  results  for  "Johnson";  phrase  searches are also unstemmed (see
-       below for details).  Stemming is currently only supported for  English.
+       There are two ways to turn this off: a search for  a  capitalized  word
+       will  be performed unstemmed, so that one can search for "John" and not
+       get results for "Johnson"; phrase  searches  are  also  unstemmed  (see
+       below  for details).  Stemming is currently only supported for English.
        Searches for words in other languages will be performed unstemmed.

  Wildcards

-       It  is  possible  to  use  a  trailing  '*' as a wildcard. A search for
+       It is possible to use a trailing  '*'  as  a  wildcard.  A  search  for
        'wildc*' will match 'wildcard', 'wildcat', etc.

  Boolean and Probabilistic Prefixes

-       Xapian (and hence notmuch)  prefixes  are  either  boolean,  supporting
-       exact  matches  like  "tag:inbox"   or probabilistic, supporting a more
-       flexible term based searching. The prefixes currently supported by not‐
-       much are as follows.
+       Xapian  (and  hence  notmuch)  prefixes  are either boolean, supporting
+       exact matches like "tag:inbox"  or  probabilistic,  supporting  a  more
+       flexible  term  based searching. Certain special prefixes are processed
+       by notmuch in a way not stricly fitting either  of  Xapian's  built  in
+       styles. The prefixes currently supported by notmuch are as follows.
 
        Boolean
               tag:, id:, thread:, folder:, path:, property:
 
        Probabilistic
-              from:, to:, subject:, attachment:, mimetype:
+              to:, attachment:, mimetype:
+
+       Special
+              from:, query:, subject:

  Terms and phrases

@@ -378,6 +393,8 @@ · non-range date queries, e.g. "date:today" · named queries e.g. "query:my_special_query" + + · regular expression searches, e.g. "subject:/^\[SPAM\]/"

SEE ALSO

@@ -394,7 +411,7 @@

COPYRIGHT

-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
-

0.23.4

+

0.24

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index b26ca22..ae3e988 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -185,7 +185,7 @@

COPYRIGHT

-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
-

0.23.4

+

0.24

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index e5f198b..f6873a1 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -114,7 +114,7 @@

COPYRIGHT

-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
-

0.23.4

+

0.24