From e4734d2e839d916a78d295c76eff880574c327db Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Thu, 4 Jun 2015 08:08:34 +0300 Subject: [PATCH] 0.20.1 manpages update --- manpages/notmuch-1.mdwn | 2 +- manpages/notmuch-address-1.mdwn | 2 +- manpages/notmuch-compact-1.mdwn | 2 +- manpages/notmuch-config-1.mdwn | 47 +++++-- manpages/notmuch-count-1.mdwn | 2 +- manpages/notmuch-dump-1.mdwn | 54 +++---- manpages/notmuch-hooks-5.mdwn | 2 +- manpages/notmuch-insert-1.mdwn | 2 +- manpages/notmuch-new-1.mdwn | 2 +- manpages/notmuch-reply-1.mdwn | 2 +- manpages/notmuch-restore-1.mdwn | 5 +- manpages/notmuch-search-1.mdwn | 4 +- manpages/notmuch-search-terms-7.mdwn | 201 ++++++++++++++++++++------- manpages/notmuch-show-1.mdwn | 2 +- manpages/notmuch-tag-1.mdwn | 2 +- 15 files changed, 232 insertions(+), 99 deletions(-) diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 79ca06b..ab4c591 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -152,4 +152,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index c0165ae..b252205 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -104,4 +104,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index bffcc5d..1f52072 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -64,4 +64,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 25d4ad0..67903ae 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -48,19 +48,31 @@ within a sub-directory of the path configured here named .notmuch. + Default: $MAILDIR variable if set, otherwise $HOME/mail. + user.name Your full name. + Default: $NAME variable if set, otherwise read from + /etc/passwd. + user.primary_email Your primary email address. + Default: $EMAIL variable if set, otherwise constructed from + the username and hostname of the current machine. + user.other_email A list of other email addresses at which you receive email. + Default: not set. + new.tags A list of tags that will be added to all messages incorpo‐ rated by notmuch new. + Default: unread;inbox. + new.ignore A list of file and directory names, without path, that will not be searched for messages by notmuch new. All the files @@ -68,14 +80,19 @@ be ignored, regardless of the location in the mail store directory hierarchy. + Default: empty list. + search.exclude_tags A list of tags that will be excluded from search results by default. Using an excluded tag in a query will override that exclusion. + Default: empty list. Note that notmuch-setup(1) puts + deleted;spam here when creating new configuration file. + maildir.synchronize_flags - If true, then the following maildir flags (in message file‐ - names) will be synchronized with the corresponding notmuch + If true, then the following maildir flags (in message file‐ + names) will be synchronized with the corresponding notmuch tags: ┌─────┬────────────────────────────┐ @@ -89,21 +106,29 @@ ├─────┼────────────────────────────┤ │R │ replied │ ├─────┼────────────────────────────┤ - │S │ unread (added when 'S' │ + │S │ unread (added when 'S' │ │ │ flag is not present) │ └─────┴────────────────────────────┘ The notmuch new command will notice flag changes in filenames - and update tags, while the notmuch tag and notmuch restore - commands will notice tag changes and update flags in file‐ + and update tags, while the notmuch tag and notmuch restore + commands will notice tag changes and update flags in file‐ names. - If there have been any changes in the maildir (new messages - added, old ones removed or renamed, maildir flags changed, - etc.), it is advisable to run notmuch new before notmuch tag - or notmuch restore commands to ensure the tag changes are - properly synchronized to the maildir flags, as the commands + If there have been any changes in the maildir (new messages + added, old ones removed or renamed, maildir flags changed, + etc.), it is advisable to run notmuch new before notmuch tag + or notmuch restore commands to ensure the tag changes are + properly synchronized to the maildir flags, as the commands expect the database and maildir to be in sync. + + Default: true. + + crypto.gpg_path + Name (or full path) of gpg binary to use in verification and + decryption of PGP/MIME messages. + + Default: gpg.

ENVIRONMENT

@@ -135,4 +160,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index a6810d4..161622f 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -72,4 +72,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 00d8ef1..a1c6131 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch  dump  [--format=(batch-tag|sup)]  [--]  [--output=<file>] [--]
+       notmuch dump [--gzip] [--format=(batch-tag|sup)] [--output=<file>] [--]
        [<search-term> ...]
@@ -22,50 +22,54 @@ therefore the only critical thing to backup (and much more friendly to incremental backup than the native database files.) - --gzip Compress the output in a format compatible with gzip(1). + See notmuch-search-terms(7) for details of the supported syntax for + <search-terms>. With no search terms, a dump of all messages in the + database will be generated. A "--" argument instructs notmuch that the + remaining arguments are search terms. - --format=(sup|batch-tag) - Notmuch restore supports two plain text dump formats, both with - one message-id per line, followed by a list of tags. + Supported options for dump include - batch-tag - The default batch-tag dump format is intended to more - robust against malformed message-ids and tags containing - whitespace or non-ascii(7) characters. Each line has the + --gzip Compress the output in a format compatible with gzip(1). + + --format=(sup|batch-tag) + Notmuch restore supports two plain text dump formats, both + with one message-id per line, followed by a list of tags. + + batch-tag + The default batch-tag dump format is intended to more + robust against malformed message-ids and tags containing + whitespace or non-ascii(7) characters. Each line has the form - +<encoded-tag> +<encoded-tag> ... -- id:<quoted-mes‐ + +<encoded-tag> +<encoded-tag> ... -- id:<quoted-mes‐ sage-id> Tags are hex-encoded by replacing every byte not matching the regex [A-Za-z0-9@=.,_+-] with %nn where nn is the two - digit hex encoding. The message ID is a valid Xapian + digit hex encoding. The message ID is a valid Xapian query, quoted using Xapian boolean term quoting rules: if - the ID contains whitespace or a close paren or starts + the ID contains whitespace or a close paren or starts with a double quote, it must be enclosed in double quotes - and double quotes inside the ID must be doubled. The - astute reader will notice this is a special case of the + and double quotes inside the ID must be doubled. The + astute reader will notice this is a special case of the batch input format for notmuch-tag(1); note that the sin‐ gle message-id query is mandatory for notmuch-restore(1). - sup The sup dump file format is specifically chosen to be + sup + The sup dump file format is specifically chosen to be compatible with the format of files produced by sup-dump. So if you've previously been using sup for mail, then the - notmuch restore command provides you a way to import all + notmuch restore command provides you a way to import all of your tags (or labels as sup calls them). Each line has the following form <message-id> ( <tag> ... ) with zero or more tags are separated by spaces. Note that - (malformed) message-ids may contain arbitrary non-null - characters. Note also that tags with spaces will not be + (malformed) message-ids may contain arbitrary non-null + characters. Note also that tags with spaces will not be correctly restored with this format. - With no search terms, a dump of all messages in the database - will be generated. A "--" argument instructs notmuch that the - remaining arguments are search terms. - - See notmuch-search-terms(7) for details of the supported syntax - for <search-terms>. + --output=<filename> + Write output to given file instead of stdout.

SEE ALSO

@@ -86,4 +90,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index be98dde..deb45f1 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -66,4 +66,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 56a2b2a..dbbd465 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -81,4 +81,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index 2366fa2..2de13fb 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -63,4 +63,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 79ef1ff..9ce2e2e 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -119,4 +119,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index d9546bc..1d7bdd9 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -53,6 +53,9 @@ supported format, this heuristic, based the fact that batch-tag format contains no parentheses, should be accurate. + + --input=<filename> + Read input from given file instead of stdin.

GZIPPED INPUT

@@ -80,4 +83,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index c6f9361..2ef9af0 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|sender|recipients) + --output=(summary|threads|messages|files|tags) summary Output a summary of each thread with any message matching @@ -166,4 +166,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index ee5c1b2..e405811 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -43,6 +43,8 @@ · attachment:<word> + · mimetype:<word> + · tag:<tag> (or is:<tag>) · id:<message-id> @@ -69,40 +71,43 @@ The attachment: prefix can be used to search for specific filenames (or extensions) of attachments to email messages. - 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 + 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 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: @@ -115,28 +120,124 @@ <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. + - In addition to individual terms, multiple terms can be combined with - Boolean operators ( and, or, not , etc.). 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 until we get Xapian defect #402 fixed). - - 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 +

  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
+       <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
+       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
+       operators specific to text searching.
+
+          notmuch search term1 NEAR term2
+
+       will return results where term1  is  within  10  words  of  term2.  The
+       threshold can be set like this:
+
+          notmuch search term1 NEAR/2 term2
+
+       The search
+
+          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
+       NEAR:
+
+          notmuch search term1 ADJ/7 term2
+
+ +

  Stemming

+
+       Stemming in notmuch means that these searches
+
+          notmuch search detailed
+          notmuch search details
+          notmuch search detail
+
+       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.
+       Searches for words in other languages will be performed unstemmed.
+
+ +

  Wildcards

+
+       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.
+
+              ┌───────────────────────────┬────────────────────────────┐
+              │Boolean
+              ├───────────────────────────┼────────────────────────────┤
+              │
+              │
+              │       thread:     folder: │        subject:    attach‐ │
+              │       path:               │        ment: mimetype:     │
+              └───────────────────────────┴────────────────────────────┘
+
+ +

  Terms and phrases

+
+       In general Xapian distinguishes between lists  of  terms  and  phrases.
+       Phrases are indicated by double quotes (but beware you probably need to
+       protect those from your shell) and insist that  those  unstemmed  words
+       occur  in  that  order. One useful, but initially surprising feature is
+       that the following are equivalant ways to write the same phrase.
+
+       · "a list of words"
+
+       · a-list-of-words
+
+       · a/list/of/words
+
+       · a.list.of.words
+
+       Both parenthesised lists of terms and quoted phrases are ok with proba‐
+       bilisitic prefixes such as to:, from:, and subject:. In particular
+
+          subject:(pizza free)
+
+       is equivalent to
+
+          subject:pizza and subject:free
+
+       Both of these will match a subject "Free Delicious Pizza" while
+
+          subject:"pizza free"
+
+       will not.

DATE AND TIME SEARCH

-       notmuch understands a variety of standard and natural ways of  express‐
+       notmuch  understands a variety of standard and natural ways of express‐
        ing dates and times, both in absolute terms ("2012-10-24") and in rela‐
-       tive terms ("yesterday"). Any number of relative terms can be  combined
-       ("1  hour  25  minutes") and an absolute date/time can be combined with
-       relative terms to further adjust it. A  non-exhaustive  description  of
+       tive  terms ("yesterday"). Any number of relative terms can be combined
+       ("1 hour 25 minutes") and an absolute date/time can  be  combined  with
+       relative  terms  to  further adjust it. A non-exhaustive description of
        the syntax supported for absolute and relative terms is given below.
@@ -144,28 +245,28 @@ 
        date:<since>..<until>
 
-       The  above  expression  restricts  the  results  to  only messages from
+       The above expression  restricts  the  results  to  only  messages  from
        <since> to <until>, based on the Date: header.
 
-       <since> and <until> can describe imprecise times, such as  "yesterday".
-       In  this  case, <since> is taken as the earliest time it could describe
+       <since>  and <until> can describe imprecise times, such as "yesterday".
+       In this case, <since> is taken as the earliest time it  could  describe
        (the beginning of yesterday) and <until> is taken as the latest time it
-       could  describe (the end of yesterday). Similarly, date:january..febru‐
+       could describe (the end of yesterday). Similarly,  date:january..febru‐
        ary matches from the beginning of January to the end of February.
 
-       Currently, we do not support  spaces  in  range  expressions.  You  can
+       Currently,  we  do  not  support  spaces  in range expressions. You can
        replace the spaces with '_', or (in most cases) '-', or (in some cases)
-       leave the spaces out altogether. Examples in this man page  use  spaces
+       leave  the  spaces out altogether. Examples in this man page use spaces
        for clarity.
 
-       Open-ended  ranges are supported (since Xapian 1.2.1), i.e. it's possi‐
-       ble to specify date:..<until> or date:<since>.. to not limit the  start
+       Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's  possi‐
+       ble  to specify date:..<until> or date:<since>.. to not limit the start
        or end time, respectively. Pre-1.2.1 Xapian does not report an error on
        open ended ranges, but it does not work as expected either.
 
-       Entering date:expr without  ".."  (for  example  date:yesterday)  won't
-       work,  as  it's  not  interpreted as a range expression at all. You can
-       achieve the expected result by duplicating the expr both sides of  ".."
+       Entering  date:expr  without  ".."  (for  example date:yesterday) won't
+       work, as it's not interpreted as a range expression  at  all.  You  can
+       achieve  the expected result by duplicating the expr both sides of ".."
        (for example date:yesterday..yesterday).
@@ -176,15 +277,15 @@ All refer to past, can be repeated and will be accumulated. - Units can be abbreviated to any length, with the otherwise ambiguous + Units can be abbreviated to any length, with the otherwise ambiguous single m being m for minutes and M for months. - Number can also be written out one, two, ..., ten, dozen, hundred. + Number can also be written out one, two, ..., ten, dozen, hundred. Additionally, the unit may be preceded by "last" or "this" (e.g., "last week" or "this month"). - When combined with absolute date and time, the relative date and time - specification will be relative from the specified absolute date and + When combined with absolute date and time, the relative date and time + specification will be relative from the specified absolute date and time. Examples: 5M2d, two weeks @@ -245,8 +346,8 @@

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(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(1), notmuch-show(1), notmuch-tag(1)
@@ -260,4 +361,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 7e077a7..89a7fb7 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -188,4 +188,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index dea0564..45df3e8 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -117,4 +117,4 @@ 2014, Carl Worth and many others -

0.19

+

0.20.1

-- 2.43.0