From 29654905e64093a5275f4a554527231072efccb9 Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Tue, 9 Jan 2018 23:00:51 +0200 Subject: [PATCH] manpages updates for release 0.26 --- manpages.mdwn | 4 +- manpages/notmuch-1.mdwn | 68 +++--- manpages/notmuch-address-1.mdwn | 80 ++++--- manpages/notmuch-compact-1.mdwn | 18 +- manpages/notmuch-config-1.mdwn | 296 ++++++++++++++--------- manpages/notmuch-count-1.mdwn | 50 ++-- manpages/notmuch-dump-1.mdwn | 86 +++---- manpages/notmuch-emacs-mua-1.mdwn | 77 +++--- manpages/notmuch-hooks-5.mdwn | 34 +-- manpages/notmuch-insert-1.mdwn | 76 +++--- manpages/notmuch-new-1.mdwn | 34 ++- manpages/notmuch-properties-7.mdwn | 129 ++++++++++ manpages/notmuch-reindex-1.mdwn | 68 ++++++ manpages/notmuch-reply-1.mdwn | 45 ++-- manpages/notmuch-restore-1.mdwn | 106 +++++---- manpages/notmuch-search-1.mdwn | 187 ++++++++------- manpages/notmuch-search-terms-7.mdwn | 337 +++++++++++++-------------- manpages/notmuch-show-1.mdwn | 227 +++++++++--------- manpages/notmuch-tag-1.mdwn | 65 +++--- 19 files changed, 1165 insertions(+), 822 deletions(-) create mode 100644 manpages/notmuch-properties-7.mdwn create mode 100644 manpages/notmuch-reindex-1.mdwn diff --git a/manpages.mdwn b/manpages.mdwn index 96d1581..b677ae1 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -10,16 +10,18 @@ Manual page index * 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-reindex(1) - re-index matching messages * notmuch-reply(1) - constructs a reply template for a set of messages * notmuch-restore(1) - restores the tags from the given file (see notmuch dump) * notmuch-search(1) - search for messages matching the given search terms * notmuch-show(1) - show messages matching the given search terms * notmuch-tag(1) - add/remove tags for all messages matching the search terms * notmuch-hooks(5) - hooks for notmuch +* notmuch-properties(7) - notmuch message property conventions and documentation * notmuch-search-terms(7) - syntax for notmuch queries 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.24

+

0.26

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index da44ca9..cb5242f 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -41,23 +41,23 @@
        Supported global options for notmuch include
 
-          --help [command-name]
-                 Print a synopsis of available commands  and  exit.   With  an
-                 optional command name, show the man page for that subcommand.
+       --help [command-name]
+              Print a  synopsis  of  available  commands  and  exit.  With  an
+              optional command name, show the man page for that subcommand.
 
-          --version
-                 Print the installed version of notmuch, and exit.
+       --version
+              Print the installed version of notmuch, and exit.
 
-          --config=FILE
-                 Specify  the  configuration  file  to use. This overrides any
-                 configuration file specified by ${NOTMUCH_CONFIG}.
+       --config=FILE
+              Specify  the  configuration file to use. This overrides any con‐
+              figuration file specified by ${NOTMUCH_CONFIG}.
 
-          --uuid=HEX
-                 Enforce that the database UUID  (a  unique  identifier  which
-                 persists  until  e.g. the database is compacted) is HEX; exit
-                 with an error if it is not. This is useful to detect rollover
-                 in  modification  counts  on messages. You can find this UUID
-                 using e.g. notmuch count --lastmod
+       --uuid=HEX
+              Enforce that the database UUID (a unique identifier  which  per‐
+              sists until e.g. the database is compacted) is HEX; exit with an
+              error if it is not. This is useful to detect rollover in modifi‐
+              cation  counts  on  messages.  You can find this UUID using e.g.
+              notmuch count --lastmod
 
        All global options except --config can also be specified after the com‐
        mand.  For example, notmuch subcommand --uuid=HEX is equivalent to not-
@@ -122,7 +122,19 @@
        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.
+       ridden using external commands.
+
+ +

  OPTION SYNTAX

+
+       All options accepting an argument can be used with '=' or ':' as a sep‐
+       arator. For the cases where it's not ambiguous (in particular excluding
+       boolean options), a space can also  be  used.  The  following  are  all
+       equivalent:
+
+          notmuch --config=alt-config config get user.name
+          notmuch --config:alt-config config get user.name
+          notmuch --config alt-config config get user.name
 

ENVIRONMENT

@@ -131,37 +143,37 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not‐ - much will use ${HOME}/.notmuch-config if this variable is not + Specifies the location of the notmuch configuration file. Not‐ + much will use ${HOME}/.notmuch-config if this variable is not set. NOTMUCH_TALLOC_REPORT - Location to write a talloc memory usage report. See tal- + Location to write a talloc memory usage report. See tal- loc_enable_leak_report_full in talloc(3) for more information. NOTMUCH_DEBUG_QUERY - If set to a non-empty value, the notmuch library will print (to + If set to a non-empty value, the notmuch library will print (to stderr) Xapian queries it constructs.

SEE ALSO

-       notmuch-address(1),    notmuch-compact(1),    notmuch-config(1),   not‐
+       notmuch-address(1),   notmuch-compact(1),    notmuch-config(1),    not‐
        much-count(1),  notmuch-dump(1),  notmuch-hooks(5),  notmuch-insert(1),
-       notmuch-new(1),      notmuch-reply(1),     notmuch-restore(1),     not‐
-       much-search(1),    notmuch-search-terms(7),    notmuch-show(1),    not‐
-       much-tag(1)
+       notmuch-new(1),   notmuch-properties(7),    notmuch-reindex(1),    not‐
+       much-reply(1),      notmuch-restore(1),     notmuch-search(1),     not‐
+       much-search-terms(7), notmuch-show(1), notmuch-tag(1)
 
        The notmuch website: https://notmuchmail.org
 

CONTACT

-       Feel  free to send questions, comments, or kudos to the notmuch mailing
-       list <notmuch@notmuchmail.org> . Subscription is  not  required  before
+       Feel free to send questions, comments, or kudos to the notmuch  mailing
+       list  <notmuch@notmuchmail.org>  .  Subscription is not required before
        posting, but is available from the notmuchmail.org website.
 
-       Real-time  interaction  with the Notmuch community is available via IRC
+       Real-time interaction with the Notmuch community is available  via  IRC
        (server: irc.freenode.net, channel: #notmuch).
 
@@ -172,7 +184,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index 716adf6..a62ef71 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -20,18 +20,18 @@ 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) + --format=(json|sexp|text|text0) + Presents the results in either JSON, S-Expressions, newline + character separated plain-text (default), or null character sep‐ + arated 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|address) 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‐ @@ -53,10 +53,15 @@ Note: With this option, addresses are printed only after the whole search is finished. This may take long time. - --deduplicate=(no|mailbox|address) + address + Output only the email addresses instead of the full mail‐ + boxes with names and email addresses. This option has no + effect on the JSON or S-Expression output formats. + + --deduplicate=(no|mailbox|address) Control the deduplication of results. - no Output all occurences of addresses in the matching mes‐ + no Output all occurrences of addresses in the matching mes‐ sages. This is not applicable with --output=count. mailbox @@ -73,30 +78,29 @@ frequently among the matching messages. If --output=count is specified, include all variants in the count. - --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). + --sort=(newest-first|oldest-first) + This option can be used to present results in either chronologi‐ + cal order (oldest-first) or reverse chronological order (new- + est-first). - By default, results will be displayed in reverse chronologi‐ - cal order, (that is, the newest results will be displayed - first). + By default, results will be displayed in reverse chronological + order, (that is, the newest results will be displayed first). - However, if either --output=count or --deduplicate=address is - specified, this option is ignored and the order of the - results is unspecified. + However, if either --output=count or --deduplicate=address is + specified, this option is ignored and the order of the results + is unspecified. - --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. + --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. + The default value, true, prevents excluded messages from match‐ + ing the search terms. - false allows excluded messages to match search terms and - appear in displayed results. + false allows excluded messages to match search terms and appear + in displayed results.

EXIT STATUS

@@ -110,9 +114,9 @@

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‐
+       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)
 
@@ -123,7 +127,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index 0aaf74e..dada006 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -25,14 +25,14 @@ Supported options for compact include - --backup=<directory> - Save the current database to the given directory before - replacing it with the compacted database. The backup direc‐ - tory must not exist and it must reside on the same mounted - filesystem as the current database. + --backup=<directory> + Save the current database to the given directory before replac‐ + ing it with the compacted database. The backup directory must + not exist and it must reside on the same mounted filesystem as + the current database. - --quiet - Do not report database compaction progress to stdout. + --quiet + Do not report database compaction progress to stdout.

ENVIRONMENT

@@ -61,7 +61,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index b4eed69..5126999 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -17,126 +17,198 @@

DESCRIPTION

        The  config  command  can be used to get or set settings in the notmuch
-       configuration file.
+       configuration file and corresponding database.
 
-          get    The value of the specified configuration item is  printed  to
-                 stdout.  If the item has multiple values (it is a list), each
-                 value is separated by a newline character.
+       Items marked [STORED IN DATABASE]  are  only  in  the  database.   They
+       should  not be placed in the configuration file, and should be accessed
+       programmatically as described in the SYNOPSIS above.
 
-          set    The specified configuration item is set to the  given  value.
-                 To specify a multiple-value item (a list), provide each value
-                 as a separate command-line argument.
+       get    The value of the specified configuration item is printed to std‐
+              out.  If the item has multiple values (it is a list), each value
+              is separated by a newline character.
 
-                 If no values are provided, the specified  configuration  item
-                 will be removed from the configuration file.
+       set    The specified configuration item is set to the given  value.  To
+              specify  a multiple-value item (a list), provide each value as a
+              separate command-line argument.
 
-          list   Every configuration item is printed to stdout, each on a sep‐
-                 arate line of the form:
+              If no values are provided, the specified configuration item will
+              be removed from the configuration file.
 
-                 section.item=value
+       list   Every  configuration  item is printed to stdout, each on a sepa‐
+              rate line of the form:
 
-                 No additional whitespace surrounds the  dot  or  equals  sign
-                 characters. In a multiple-value item (a list), the values are
-                 separated by semicolon characters.
+                 *section*.\ *item*\ =\ *value*
+
+              No additional whitespace surrounds the dot or equals sign  char‐
+              acters.  In a multiple-value item (a list), the values are sepa‐
+              rated by semicolon characters.
 
        The available configuration items are described below.
 
-          database.path
-                 The top-level directory where your mail currently exists  and
-                 to  where  mail will be delivered in the future. Files should
-                 be individual email messages. Notmuch will store its database
-                 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
-                 and directories matching any of the names specified here will
-                 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
-                 tags:
-
-                              ┌─────┬────────────────────────────┐
-                              │Flag │ Tag                        │
-                              ├─────┼────────────────────────────┤
-                              │D    │ draft                      │
-                              ├─────┼────────────────────────────┤
-                              │F    │ flagged                    │
-                              ├─────┼────────────────────────────┤
-                              │P    │ passed                     │
-                              ├─────┼────────────────────────────┤
-                              │R    │ replied                    │
-                              ├─────┼────────────────────────────┤
-                              │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‐
-                 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
-                 expect the database and maildir to be in sync.
-
-                 Default: true.
-
-          crypto.gpg_path
+       database.path
+              The top-level directory where your mail currently exists and  to
+              where  mail  will  be  delivered  in the future. Files should be
+              individual email  messages.  Notmuch  will  store  its  database
+              within  a  sub-directory of the path configured here named .not-
+              much.
+
+              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 incorporated
+              by notmuch new.
+
+              Default: unread;inbox.
+
+       new.ignore
+              A list to  specify  files  and  directories  that  will  not  be
+              searched  for messages by notmuch new. Each entry in the list is
+              either:
+
+              A file or a directory name, without path, that will be  ignored,
+              regardless  of  the location in the mail store directory hierar‐
+              chy.
+
+              Or:
+
+              A regular expression delimited with  //  that  will  be  matched
+              against  the path of the file or directory relative to the data‐
+              base path. Matching files and directories will be  ignored.  The
+              beginning  and  end  of  string must be explicitly anchored. For
+              example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo",  but
+              not "foo" or "bar/foobar".
+
+              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 filenames)
+              will be synchronized with the corresponding notmuch tags:
+
+                            ┌─────┬────────────────────────────┐
+                            │Flag │ Tag                        │
+                            ├─────┼────────────────────────────┤
+                            │D    │ draft                      │
+                            ├─────┼────────────────────────────┤
+                            │F    │ flagged                    │
+                            ├─────┼────────────────────────────┤
+                            │P    │ passed                     │
+                            ├─────┼────────────────────────────┤
+                            │R    │ replied                    │
+                            ├─────┼────────────────────────────┤
+                            │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 com‐
+              mands will notice tag changes and update flags in filenames.
+
+              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.
+              decryption of PGP/MIME messages.  NOTE: This configuration  item
+              is  deprecated,  and will be ignored if notmuch is built against
+              GMime 3.0 or later.
 
               Default: gpg.
 
-          built_with.<name>
+       index.decrypt [STORED IN DATABASE]
+              Policy for decrypting encrypted messages during indexing.   Must
+              be one of: false, auto, nostash, or true.
+
+              When  indexing  an encrypted e-mail message, if this variable is
+              set to true, notmuch will try to decrypt the message  and  index
+              the  cleartext,  stashing  a copy of any discovered session keys
+              for the message.  If auto, it will try to index the cleartext if
+              a  stashed  session  key  is already known for the message (e.g.
+              from a previous copy), but will not try to  access  your  secret
+              keys.  Use false to avoid decrypting even when a stashed session
+              key is already present.
+
+              nostash is the same as  true  except  that  it  will  not  stash
+              newly-discovered session keys in the database.
+
+              From   the   command  line  (i.e.  during  notmuch-new(1),  not‐
+              much-insert(1), or notmuch-reindex(1)), the  user  can  override
+              the  database's  stored  decryption  policy  with the --decrypt=
+              option.
+
+              Here is a table that summarizes the  functionality  of  each  of
+              these policies:
+
+                      ┌──────────────┬───────┬──────┬─────────┬──────┐
+                      │              │ false │ auto │ nostash │ true │
+                      ├──────────────┼───────┼──────┼─────────┼──────┤
+                      │Index cleart‐ │       │ X    │ X       │ X    │
+                      │ext     using │       │      │         │      │
+                      │stashed  ses‐ │       │      │         │      │
+                      │sion keys     │       │      │         │      │
+                      ├──────────────┼───────┼──────┼─────────┼──────┤
+                      │Index cleart‐ │       │      │ X       │ X    │
+                      │ext     using │       │      │         │      │
+                      │secret keys   │       │      │         │      │
+                      ├──────────────┼───────┼──────┼─────────┼──────┤
+                      │Stash session │       │      │         │ X    │
+                      │keys
+                      ├──────────────┼───────┼──────┼─────────┼──────┤
+                      │Delete
+                      │stashed  ses‐ │       │      │         │      │
+                      │sion  keys on │       │      │         │      │
+                      │reindex       │       │      │         │      │
+                      └──────────────┴───────┴──────┴─────────┴──────┘
+
+              Stashed session keys are kept  in  the  database  as  properties
+              associated with the message.  See session-key in notmuch-proper‐
+              ties(7) for more details about how they can be useful.
+
+              Be aware that the notmuch index  is  likely  sufficient  (and  a
+              stashed  session key is certainly sufficient) to reconstruct the
+              cleartext of the message itself, so please ensure that the  not‐
+              much   message  index  is  adequately  protected.   DO  NOT  USE
+              index.decrypt=true or index.decrypt=nostash without  considering
+              the security of your index.
+
+              Default: auto.
+
+       built_with.<name>
               Compile time feature <name>. Current possibilities include "com‐
-              pact"  (see  notmuch-compact(1)) and "field_processor" (see not‐
+              pact" (see notmuch-compact(1)) and "field_processor"  (see  not‐
               much-search-terms(7)).
 
-          query.<name>
-              Expansion   for   named   query   called   <name>.   See    not‐
+       query.<name> [STORED IN DATABASE]
+              Expansion    for   named   query   called   <name>.   See   not‐
               much-search-terms(7) for more information about named queries.
 
@@ -146,17 +218,17 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not‐ - much will use ${HOME}/.notmuch-config if this variable is not + Specifies the location of the notmuch configuration file. Not‐ + much will use ${HOME}/.notmuch-config if this variable is not set.

SEE ALSO

-       notmuch(1), notmuch-count(1), notmuch-dump(1),  notmuch-hooks(5),  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)
+       notmuch(1),  notmuch-count(1),  notmuch-dump(1), notmuch-hooks(5), not‐
+       much-insert(1), notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
+       notmuch-search(1), notmuch-search-terms(7), notmuch-properties(7), not‐
+       much-show(1), notmuch-tag(1)
 

AUTHOR

@@ -166,7 +238,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index bdfe013..f28687a 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -23,7 +23,8 @@ <search-terms>. Supported options for count include - --output=(messages|threads|files) + + --output=(messages|threads|files) messages Output the number of matching messages. This is the @@ -37,32 +38,31 @@ messages due to duplicates (i.e. multiple files having the same message-id). - --exclude=(true|false) - Specify whether to omit messages matching search.tag_exclude - from the count (the default) or not. - - --batch - Read queries from a file (stdin by default), one per line, - and output the number of matching messages (or threads) to - stdout, one per line. On an empty input line the count of all - messages (or threads) in the database will be output. This - option is not compatible with specifying search terms on the - command line. - - --lastmod - Append lastmod (counter for number of database updates) and - UUID to the output. lastmod values are only comparable - between databases with the same UUID. - - --input=<filename> - Read input from given file, instead of from stdin. Implies - --batch. + --exclude=(true|false) + Specify whether to omit messages matching search.tag_exclude + from the count (the default) or not. + + --batch + Read queries from a file (stdin by default), one per line, and + output the number of matching messages (or threads) to stdout, + one per line. On an empty input line the count of all messages + (or threads) in the database will be output. This option is not + compatible with specifying search terms on the command line. + + --lastmod + Append lastmod (counter for number of database updates) and UUID + to the output. lastmod values are only comparable between data‐ + bases with the same UUID. + + --input=<filename> + Read input from given file, instead of from stdin. Implies + --batch.

SEE ALSO

-       notmuch(1), notmuch-config(1), notmuch-dump(1), notmuch-hooks(5),  not‐
-       much-insert(1),  notmuch-new(1),  notmuch-reply(1), notmuch-restore(1),
+       notmuch(1),  notmuch-config(1), notmuch-dump(1), notmuch-hooks(5), 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)
 
@@ -74,7 +74,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 00239be..c939daa 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -29,82 +29,82 @@ Supported options for dump include - --gzip Compress the output in a format compatible with gzip(1). + --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. + --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 + 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‐ - sage-id> + form: + + +<*encoded-tag*\ > +<*encoded-tag*\ > ... -- id:<*quoted-message-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> ... ) + 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. - --include=(config|properties|tags) + --include=(config|properties|tags) + Control what kind of metadata is included in the output. - Control what kind of metadata is included in the output. - config - Output configuration data stored in the database. Each line - starts with "#@ ", followed by a space separated key-value - pair. Both key and value are hex encoded if needed. + config Output configuration data stored in the database. Each + line starts with "#@ ", followed by a space separated + key-value pair. Both key and value are hex encoded if + needed. properties - Output per-message (key,value) metadata. Each line starts - with "#= ", followed by a message id, and a space separated - list of key=value pairs. pair. Ids, keys and values are hex - encoded if needed. + Output per-message (key,value) metadata. Each line + starts with "#= ", followed by a message id, and a space + separated list of key=value pairs. Ids, keys and values + are hex encoded if needed. See notmuch-properties(7) for + more details. - tags - Output per-message boolean metadata, namely tags. See format - above for description of the output. + tags Output per-message boolean metadata, namely tags. See + format above for description of the output. - The default is to include all available types of data. The + The default is to include all available types of data. The option can be specified multiple times to select some subset. As - of version 2 of the dump format, there is a header line of the - following form + of version 3 of the dump format, there is a header line of the + following form: - #notmuch-dump <format>:<version> <included> + #notmuch-dump <*format*>:<*version*> <*included*> where <included> is a comma separated list of the above options. - --output=<filename> - Write output to given file instead of stdout. + --output=<filename> + Write output to given file instead of stdout.

SEE ALSO

        notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-hooks(5), 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)
+       much-insert(1),     notmuch-new(1),     notmuch-properties(7),     not‐
+       much-reply(1),     notmuch-restore(1),     notmuch-search(1),      not‐
+       much-search-terms(7), notmuch-show(1), notmuch-tag(1)
 

AUTHOR

@@ -114,7 +114,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn index 07f56ac..a12594a 100644 --- a/manpages/notmuch-emacs-mua-1.mdwn +++ b/manpages/notmuch-emacs-mua-1.mdwn @@ -17,55 +17,52 @@ Supported options for emacs-mua include - -h, --help - Display help. + -h, --help + Display help. - -s, --subject=<subject> - Specify the subject of the message. + -s, --subject=<subject> + Specify the subject of the message. - --to=<to-address> - Specify a recipient (To). + --to=<to-address> + Specify a recipient (To). - -c, --cc=<cc-address> - Specify a carbon-copy (Cc) recipient. + -c, --cc=<cc-address> + Specify a carbon-copy (Cc) recipient. - -b, --bcc=<bcc-address> - Specify a blind-carbon-copy (Bcc) 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. + -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. + --hello + Go to the Notmuch hello screen instead of the message composi‐ + tion window if no message composition parameters are given. - --no-window-system - Even if a window system is available, use the current termi‐ - nal. + --no-window-system + Even if a window system is available, use the current terminal. - --client - Use emacsclient, rather than emacs. For emacsclient to work, - you need an already running Emacs with a server, or use - --auto-daemon. + --client + Use emacsclient, rather than emacs. For emacsclient to work, you + need an already running Emacs with a server, or use --auto-dae- + mon. - --auto-daemon - Automatically start Emacs in daemon mode, if the Emacs server - is not running. Applicable with --client. Implies --cre- - ate-frame. + --auto-daemon + Automatically start Emacs in daemon mode, if the Emacs server is + not running. Applicable with --client. Implies --create-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. + --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-daemon) + in daemon mode. - --print - Output the resulting elisp to stdout instead of evaluating - it. + --print + Output the resulting elisp to stdout instead of evaluating it. - The supported positional parameters and short options are a compatible + 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: + parameters modifying the message can't be combined with the mailto: URL. Options may be specified multiple times. @@ -76,7 +73,7 @@ EMACS Name of emacs command to invoke. Defaults to "emacs". EMACSCLIENT - Name of emacsclient command to invoke. Defaults to "emac‐ + Name of emacsclient command to invoke. Defaults to "emac‐ sclient". @@ -87,12 +84,12 @@

AUTHOR

-       Jani Nikula
+       Carl Worth and many others
 

COPYRIGHT

-       2014-2017, Jani Nikula
+       2009-2018, Carl Worth and many others
 
-

0.24

+

0.26

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index fbcbe3b..f616177 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -19,25 +19,25 @@ The currently available hooks are described below. - pre-new - This hook is invoked by the new command before scanning or - importing new messages into the database. If this hook exits - with a non-zero status, notmuch will abort further processing - of the new command. + pre-new + This hook is invoked by the new command before scanning or + importing new messages into the database. If this hook exits + with a non-zero status, notmuch will abort further processing of + the new command. - Typically this hook is used for fetching or delivering new - mail to be imported into the database. + Typically this hook is used for fetching or delivering new mail + to be imported into the database. - post-new - This hook is invoked by the new command after new messages - have been imported into the database and initial tags have - been applied. The hook will not be run if there have been any - errors during the scan or import. + post-new + This hook is invoked by the new command after new messages have + been imported into the database and initial tags have been + applied. The hook will not be run if there have been any errors + during the scan or import. - Typically this hook is used to perform additional query-based - tagging on the imported messages. + Typically this hook is used to perform additional query-based + tagging on the imported messages. - post-insert + 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 @@ -63,7 +63,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 329ebc2..bf44bdc 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -32,40 +32,62 @@ 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 - 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 - 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 successful mail delivery. - - --no-hooks - Prevent hooks from being run. + --folder=<folder> + Deliver the message to the specified folder, relative to the + top-level directory given by the value of database.path. The + default is the empty string, which means delivering 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 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 indicate suc‐ + cessful mail delivery. + + --no-hooks + Prevent hooks from being run. + + --decrypt=(true|nostash|auto|false) + If true and the message is encrypted, try to decrypt the message + while indexing, stashing any session keys discovered. If auto, + and notmuch already knows about a session key for the message, + it will try decrypting using that session key but will not try + to access the user's secret keys. If decryption is successful, + index the cleartext itself. Either way, the message is always + stored to disk in its original form (ciphertext). + + nostash is the same as true except that it will not stash + newly-discovered session keys in the database. + + Be aware that the index is likely sufficient (and a stashed ses‐ + sion key is certainly sufficient) to reconstruct the cleartext + of the message itself, so please ensure that the notmuch message + index is adequately protected. DO NOT USE --decrypt=true or + --decrypt=nostash without considering the security of your + index. + + See also index.decrypt in notmuch-config(1).

EXIT STATUS

-       This command  returns  exit  status  0  on  successful  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
+       This  command  returns  exit  status  0  on  successful  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.
 
        This command supports the following special exit status code for errors
-       most likely to be temporary in nature, e.g. failure to get  a  database
+       most  likely  to be temporary in nature, e.g. failure to get a database
        write lock.
 
        75 (EX_TEMPFAIL)
-              A temporary failure occured; the user is invited to retry.
+              A temporary failure occurred; the user is invited to retry.
 
        The exit status of the post-insert hook does not affect the exit status
        of the insert command.
@@ -73,7 +95,7 @@
 
 

SEE ALSO

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

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index ffe641f..345f510 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -38,11 +38,27 @@ Supported options for new include - --no-hooks - Prevents hooks from being run. - - --quiet - Do not print progress or results. + --no-hooks + Prevents hooks from being run. + + --quiet + Do not print progress or results. + + --decrypt=(true|nostash|auto|false) + If true, when encountering an encrypted message, try to decrypt + it while indexing, and stash any discovered session keys. If + auto, try to use any session key already known to belong to this + message, but do not attempt to use the user's secret keys. If + decryption is successful, index the cleartext of the message. + + Be aware that the index is likely sufficient (and the session + key is certainly sufficient) to reconstruct the cleartext of the + message itself, so please ensure that the notmuch message index + is adequately protected. DO NOT USE --decrypt=true or + --decrypt=nostash without considering the security of your + index. + + See also index.decrypt in notmuch-config(1).

EXIT STATUS

@@ -50,12 +66,12 @@ This command supports the following special exit status code 75 (EX_TEMPFAIL) - A temporary failure occured; the user is invited to retry. + A temporary failure occurred; the user is invited to retry.

SEE ALSO

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

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-properties-7.mdwn b/manpages/notmuch-properties-7.mdwn new file mode 100644 index 0000000..45af3a3 --- /dev/null +++ b/manpages/notmuch-properties-7.mdwn @@ -0,0 +1,129 @@ +

NOTMUCH-PROPERTIES(7)

+ +

NAME

+
+       notmuch-properties  - notmuch message property conventions and documen‐
+       tation
+
+ +

SYNOPSIS

+
+       notmuch count property:<key>=<value>
+
+       notmuch search property:<key>=<value>
+
+       notmuch show property:<key>=<value>
+
+       notmuch reindex property:<key>=<value>
+
+       notmuch tag +<tag> property:<key>=<value>
+
+       notmuch dump --include=properties
+
+       notmuch restore --include=properties
+
+ +

DESCRIPTION

+
+       Several notmuch commands can search for, modify, add or remove  proper‐
+       ties  associated  with  specific  messages.   Properties  are key/value
+       pairs, and a message can have more than one key/value pair for the same
+       key.
+
+       While  users  can  select  based on a specific property in their search
+       terms with the prefix property:,  the  notmuch  command-line  interface
+       does  not  provide  mechanisms for modifying properties directly to the
+       user.
+
+       Instead, message properties are expected to be set and used programmat‐
+       ically, according to logic in notmuch itself, or in extensions to it.
+
+       Extensions  to  notmuch  which make use of properties are encouraged to
+       report the specific properties used to the upstream notmuch project, as
+       a way of avoiding collisions in the property namespace.
+
+ +

CONVENTIONS

+
+       Any  property with a key that starts with "index." will be removed (and
+       possibly re-set) upon reindexing (see notmuch-reindex(1)).
+
+ +

MESSAGE PROPERTIES

+
+       The following properties are set by notmuch internally in the course of
+       its normal activity.
+
+       index.decryption
+              If  a  message  contains encrypted content, and notmuch tries to
+              decrypt that content during indexing, it will add  the  property
+              index.decryption=success  when  the  cleartext  was successfully
+              indexed.  If notmuch attempts to decrypt any part of  a  message
+              during  indexing  and that decryption attempt fails, it will add
+              the property index.decryption=failure to the message.
+
+              Note that it's possible  for  a  single  message  to  have  both
+              index.decryption=success and index.decryption=failure.  Consider
+              an encrypted e-mail  message  that  contains  another  encrypted
+              e-mail  message  as an attachment -- if the outer message can be
+              decrypted, but the attached part cannot,  then  both  properties
+              will be set on the message as a whole.
+
+              If  notmuch  never  tried to decrypt an encrypted message during
+              indexing (which  is  the  default,  see  index.decrypt  in  not‐
+              much-config(1)), then this property will not be set on that mes‐
+              sage.
+
+       session-key
+          When notmuch-show(1) or nomtuch-reply encounters a message  with  an
+          encrypted  part,  if notmuch finds a session-key property associated
+          with the message, it will try that stashed session key  for  decryp‐
+          tion.
+
+          If  you  do  not  want to use any stashed session keys that might be
+          present, you should pass those programs --decrypt=false.
+
+          Using a stashed session key with "notmuch show" will speed  up  ren‐
+          dering  of  long  encrypted  threads.   It  also  allows the user to
+          destroy the secret part of  any  expired  encryption-capable  subkey
+          while  still being able to read any retained messages for which they
+          have stashed the session key.  This enables truly deletable  e-mail,
+          since   (once  the  session  key  and  asymmetric  subkey  are  both
+          destroyed) there are no keys left that can be used  to  decrypt  any
+          copy of the original message previously stored by an adversary.
+
+          However,  access to the stashed session key for an encrypted message
+          permits full byte-for-byte reconstruction of the cleartext  message.
+          This includes attachments, cryptographic signatures, and other mate‐
+          rial that cannot be reconstructed from the index alone.
+
+          See index.decrypt in notmuch-config(1) for more details about how to
+          set notmuch's policy on when to store session keys.
+
+          The  session key should be in the ASCII text form produced by GnuPG.
+          For OpenPGP, that consists of a decimal representation of  the  hash
+          algorithm  used  (identified  by  number from RFC 4880, e.g. 9 means
+          AES-256) followed by a colon, followed by a hexadecimal  representa‐
+          tion  of  the  algorithm-specific  key.  For example, an AES-128 key
+          might   be   stashed   in    a    notmuch    property    as:    ses-
+          sion-key=7:14B16AF65536C28AF209828DFE34C9E0.
+
+ +

SEE ALSO

+
+       notmuch(1), notmuch-config(1), notmuch-dump(1), notmuch-insert(1), not‐
+       much-new(1), notmuch-reindex(1), notmuch-reply(1),  notmuch-restore(1),
+       notmuch-show(1), *notmuch-search-terms(7)
+
+ +

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.26

diff --git a/manpages/notmuch-reindex-1.mdwn b/manpages/notmuch-reindex-1.mdwn new file mode 100644 index 0000000..2ca91be --- /dev/null +++ b/manpages/notmuch-reindex-1.mdwn @@ -0,0 +1,68 @@ +

NOTMUCH-REINDEX(1)

+ +

NAME

+
+       notmuch-reindex - re-index matching messages
+
+ +

SYNOPSIS

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

DESCRIPTION

+
+       Re-index all messages matching the search terms.
+
+       See  notmuch-search-terms(7)  for  details  of the supported syntax for
+       <search-term>.
+
+       The reindex command searches for all  messages  matching  the  supplied
+       search  terms,  and  re-creates  the  full-text index on these messages
+       using the supplied options.
+
+       Supported options for reindex include
+
+       --decrypt=(true|nostash|auto|false)
+              If true, when encountering an encrypted message, try to  decrypt
+              it  while  reindexing, stashing any session keys discovered.  If
+              auto, and notmuch already knows about a session key for the mes‐
+              sage, it will try decrypting using that session key but will not
+              try to access the user's secret keys.  If decryption is success‐
+              ful, index the cleartext itself.
+
+              nostash  is  the  same  as  true  except  that it will not stash
+              newly-discovered session keys in the database.
+
+              If false, notmuch reindex will also delete any  stashed  session
+              keys for all messages matching the search terms.
+
+              Be aware that the index is likely sufficient (and a stashed ses‐
+              sion key is certainly sufficient) to reconstruct  the  cleartext
+              of the message itself, so please ensure that the notmuch message
+              index is adequately protected.  DO  NOT  USE  --decrypt=true  or
+              --decrypt=nostash  without  considering  the  security  of  your
+              index.
+
+              See also index.decrypt in notmuch-config(1).
+
+ +

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(1),  notmuch-search-terms(7),  not‐
+       much-show(1), notmuch-tag(1)
+
+ +

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.26

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 83010f2..ff43d28 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -34,7 +34,8 @@ The resulting message template is output to stdout. Supported options for reply include - --format=(default|json|sexp|headers-only) + + --format=(default|json|sexp|headers-only) default Includes subject and quoted message body as an RFC 2822 @@ -54,14 +55,14 @@ Only produces In-Reply-To, References, To, Cc, and Bcc headers. - --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. + --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. - --reply-to=(all|sender) + --reply-to=(all|sender) - all (default) + all (default) Replies to all addresses. sender Replies only to the sender. If replying to user's own @@ -70,16 +71,24 @@ ers in this order, and copy values from the first that contains something other than only the user's addresses. - --decrypt - Decrypt any MIME encrypted parts found in the selected con‐ - tent (ie. "multipart/encrypted" parts). Status of the decryp‐ - tion will be reported (currently only supported with --for‐ - mat=json and --format=sexp) and on successful decryption the - multipart/encrypted part will be replaced by the decrypted - content. + --decrypt=(false|auto|true) + If true, decrypt any MIME encrypted parts found in the selected con‐ + tent (i.e., "multipart/encrypted" parts). Status of the decryption + will be reported (currently only supported with --format=json and + --format=sexp), and on successful decryption the multipart/encrypted + part will be replaced by the decrypted content. + + If auto, and a session key is already known for the message, then it + will be decrypted, but notmuch will not try to access the user's + secret keys. + + Use false to avoid even automatic decryption. + + Non-automatic decryption expects a functioning gpg-agent(1) to pro‐ + vide any needed credentials. Without one, the decryption will likely + fail. - Decryption expects a functioning gpg-agent(1) to provide any - needed credentials. Without one, the decryption will fail. + Default: auto See notmuch-search-terms(7) for details of the supported syntax for <search-terms>. @@ -117,7 +126,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index c0f1782..1b22757 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -20,78 +20,76 @@ Supported options for restore include - --accumulate - The union of the existing and new tags is applied, instead of - replacing each message's tags as they are read in from the - dump file. - - --format=(sup|batch-tag|auto) - Notmuch restore supports two plain text dump formats, with - each line specifying a message-id and a set of tags. For - details of the actual formats, see notmuch-dump(1). - - 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 of your tags (or labels as sup calls - them). - - batch-tag - The batch-tag dump format is intended to more robust - against malformed message-ids and tags containing - whitespace or non-ascii(7) characters. See not‐ - much-dump(1) for details on this format. - - notmuch restore updates the maildir flags according to - tag changes if the maildir.synchronize_flags configu‐ - ration option is enabled. See notmuch-config(1) for - details. - - auto This option (the default) tries to guess the format - from the input. For correctly formed input in either - supported format, this heuristic, based the fact that - batch-tag format contains no parentheses, should be - accurate. - - --include=(config|properties|tags) + --accumulate + The union of the existing and new tags is applied, instead of + replacing each message's tags as they are read in from the dump + file. + + --format=(sup|batch-tag|auto) + Notmuch restore supports two plain text dump formats, with each + line specifying a message-id and a set of tags. For details of + the actual formats, see notmuch-dump(1). + + 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 + of your tags (or labels as sup calls them). + + batch-tag + The batch-tag dump format is intended to more robust + against malformed message-ids and tags containing white‐ + space or non-ascii(7) characters. See notmuch-dump(1) for + details on this format. + + notmuch restore updates the maildir flags according to + tag changes if the maildir.synchronize_flags configura‐ + tion option is enabled. See notmuch-config(1) for + details. + + auto This option (the default) tries to guess the format from + the input. For correctly formed input in either supported + format, this heuristic, based the fact that batch-tag + format contains no parentheses, should be accurate. + + --include=(config|properties|tags) Control what kind of metadata is restored. - config - Restore configuration data to the database. Each configu‐ + + config Restore configuration data to the database. Each configu‐ ration line starts with "#@ ", followed by a space sepa‐ rated key-value pair. Both key and value are hex encoded if needed. - properties - Output per-message (key,value) metadata. Each line + properties + Restore per-message (key,value) metadata. Each line starts with "#= ", followed by a message id, and a space - separated list of key=value pairs. pair. Ids, keys and - values are hex encoded if needed. + separated list of key=value pairs. Ids, keys and values + are hex encoded if needed. See notmuch-properties(7) for + more details. - tags - Output per-message metadata, namely tags. See format + tags Restore per-message metadata, namely tags. See format above for more details. - The default is to restore all available types of data. The + The default is to restore all available types of data. The option can be specified multiple times to select some subset. - --input=<filename> - Read input from given file instead of stdin. + --input=<filename> + Read input from given file instead of stdin.

GZIPPED INPUT

-       notmuch restore will detect if the input is compressed in gzip(1)  for‐
-       mat  and automatically decompress it while reading. This detection does
+       notmuch  restore will detect if the input is compressed in gzip(1) for‐
+       mat and automatically decompress it while reading. This detection  does
        not depend on file naming and in particular works for standard input.
 

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-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
-       much-tag(1)
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       much-hooks(5),   notmuch-insert(1),   notmuch-new(1),   notmuch-proper‐
+       ties(7),  notmuch-reply(1), notmuch-search(1), notmuch-search-terms(7),
+       notmuch-show(1), notmuch-tag(1)
 

AUTHOR

@@ -101,7 +99,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 66ff87c..b7ba7db 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -26,117 +26,130 @@ Supported options for search 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=(json|sexp|text|text0) + Presents the results in either JSON, S-Expressions, newline + character separated plain-text (default), or null character sep‐ + arated 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. + --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=(summary|threads|messages|files|tags) + --output=(summary|threads|messages|files|tags) summary Output a summary of each thread with any message matching the search terms. The summary includes the thread ID, date, the number of messages in the thread (both the num‐ ber matched and the total number), the authors of the - thread and the subject. + thread and the subject. In the case where a thread con‐ + tains multiple files for some messages, the total number + of files is printed in parentheses (see below for an + example). threads - Output the thread IDs of all threads with any message - matching the search terms, either one per line (--for‐ + Output the thread IDs of all threads with any message + matching the search terms, either one per line (--for‐ mat=text), separated by null characters (--format=text0), - as a JSON array (--format=json), or an S-Expression list + as a JSON array (--format=json), or an S-Expression list (--format=sexp). messages - Output the message IDs of all messages matching the - search terms, either one per line (--format=text), sepa‐ - rated by null characters (--format=text0), as a JSON + Output the message IDs of all messages matching the + search terms, either one per line (--format=text), sepa‐ + rated by null characters (--format=text0), as a JSON array (--format=json), or as an S-Expression list (--for‐ mat=sexp). - files Output the filenames of all messages matching the search - terms, either one per line (--format=text), separated by + files Output the filenames of all messages matching the search + terms, either one per line (--format=text), separated by null characters (--format=text0), as a JSON array (--for‐ mat=json), or as an S-Expression list (--format=sexp). - Note that each message may have multiple filenames asso‐ - ciated with it. All of them are included in the output - (unless limited with the --duplicate=N option). This may - be particularly confusing for folder: or path: searches + Note that each message may have multiple filenames asso‐ + ciated with it. All of them are included in the output + (unless limited with the --duplicate=N option). This may + be particularly confusing for folder: or path: searches in a specified directory, as the messages may have dupli‐ - cates in other directories that are included in the out‐ - put, although these files alone would not match the + cates in other directories that are included in the out‐ + put, although these files alone would not match the search. - tags Output all tags that appear on any message matching the - search terms, either one per line (--format=text), sepa‐ - rated by null characters (--format=text0), as a JSON + tags Output all tags that appear on any message matching the + search terms, either one per line (--format=text), sepa‐ + rated by null characters (--format=text0), as a JSON array (--format=json), or as an S-Expression list (--for‐ mat=sexp). - --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). - - Note: The thread order will be distinct between these two - options (beyond being simply reversed). When sorting by old- - est-first the threads will be sorted by the oldest message in - each thread, but when sorting by newest-first the threads - will be sorted by the newest message in each thread. - - By default, results will be displayed in reverse chronologi‐ - cal order, (that is, the newest results will be displayed - first). - - --offset=[-]N - Skip displaying the first N results. With the leading '-', - start at the Nth result from the end. - - --limit=N - Limit the number of displayed results to N. - - --exclude=(true|false|all|flag) - 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. - - all additionally prevents excluded messages from appearing in - displayed results, in effect behaving as though the excluded - messages do not exist. - - false allows excluded messages to match search terms and - appear in displayed results. Excluded messages are still - marked in the relevant outputs. - - flag only has an effect when --output=summary. The output is - almost identical to false, but the "match count" is the num‐ - ber of matching non-excluded messages in the thread, rather - than the number of matching messages. - - --duplicate=N - 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 - option filters filenames of the matching messages. + --sort=(newest-first|oldest-first) + This option can be used to present results in either chronologi‐ + cal order (oldest-first) or reverse chronological order (new- + est-first). + + Note: The thread order will be distinct between these two + options (beyond being simply reversed). When sorting by old- + est-first the threads will be sorted by the oldest message in + each thread, but when sorting by newest-first the threads will + be sorted by the newest message in each thread. + + By default, results will be displayed in reverse chronological + order, (that is, the newest results will be displayed first). + + --offset=[-]N + Skip displaying the first N results. With the leading '-', start + at the Nth result from the end. + + --limit=N + Limit the number of displayed results to N. + + --exclude=(true|false|all|flag) + 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. + + true (default) + Prevent excluded messages from matching the search terms. + + all Additionally prevent excluded messages from appearing in + displayed results, in effect behaving as though the + excluded messages do not exist. + + false Allow excluded messages to match search terms and appear + in displayed results. Excluded messages are still marked + in the relevant outputs. + + flag Only has an effect when --output=summary. The output is + almost identical to false, but the "match count" is the + number of matching non-excluded messages in the thread, + rather than the number of matching messages. + + --duplicate=N + 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 associ‐ + ated with them. + + Note that this option is orthogonal with the folder: search pre‐ + fix. The prefix matches messages based on filenames. This option + filters filenames of the matching messages. + + +

EXAMPLE

+
+       The following shows an example of the summary output format,  with  one
+       message having multiple filenames.
+
+          % notmuch search date:today.. and tag:bad-news
+          thread:0000000000063c10 Today [1/1] Some Persun; To the bone (inbox unread)
+          thread:0000000000063c25 Today [1/1(2)] Ann Other; Bears (inbox unread)
+          thread:0000000000063c00 Today [1/1] A Thurd; Bites, stings, sad feelings (inbox unread)
 

EXIT STATUS

@@ -163,7 +176,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index f92b7c4..0259d42 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -12,6 +12,8 @@ notmuch dump [--format=(batch-tag|sup)] [--] [--output=<file>] [--] [<search-term> ...] + notmuch reindex [option ...] <search-term> ... + notmuch search [option ...] <search-term> ... notmuch show [option ...] <search-term> ... @@ -30,151 +32,145 @@ As a special case, a search string consisting of exactly a single asterisk ("*") will match all messages. + +

  Search prefixes

+
        In addition to free text, the following prefixes can be used  to  force
        terms to match against specific portions of an email, (where <brackets>
-       indicate user-supplied values):
-
-       · from:<name-or-address>
-
-       · from:/<regex>/
-
-       · to:<name-or-address>
-
-       · subject:<word-or-quoted-phrase>
-
-       · subject:/<regex>/
-
-       · attachment:<word>
-
-       · mimetype:<word>
-
-       · tag:<tag> (or is:<tag>)
-
-       · id:<message-id>
-
-       · thread:<thread-id>
-
-       · folder:<maildir-folder>
-
-       · path:<directory-path> or path:<directory-path>/**
-
-       · date:<since>..<until>
+       indicate user-supplied values).
 
-       · lastmod:<initial-revision>..<final-revision>
-
-       · query:<name>
-
-       · property:<key>=<value>
-
-       The from: prefix is used to match the name or address of the sender  of
-       an email message.
-
-       The to: prefix is used to match the names or addresses of any recipient
-       of an email message, (whether To, Cc, or Bcc).
-
-       Any term prefixed with subject: will match only text from  the  subject
-       of  an  email.  Searching  for  a phrase in the subject is supported by
-       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 //.
+       If notmuch is built with Xapian Field Processors (see  below)  some  of
+       the  prefixes  with  <regex>  forms  can  be  also used to restrict the
+       results  to  those  whose  value  matches  a  regular  expression  (see
+       regex(7)) delimited with //, for example:
 
           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
-       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:
-       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
-       notmuch search
-
-       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
-       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
-       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
-       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
-       is in the specific directory/folder.
-
-       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:
-
-       date:<since>..<until>
-
-       See DATE AND TIME SEARCH below for details on the range expression, and
-       supported syntax for <since> and <until> date and time expressions.
-
-       The time range can also be specified using timestamps with a syntax of:
-
-       <initial-timestamp>..<final-timestamp>
-
-       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
-       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
-       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‐
-       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
-       present on a given message with several different values.
+       from:<name-or-address> or from:/<regex>/
+              The  from:  prefix  is  used to match the name or address of the
+              sender of an email message.
+
+       to:<name-or-address>
+              The to: prefix is used to match the names or  addresses  of  any
+              recipient of an email message, (whether To, Cc, or Bcc).
+
+       subject:<word-or-quoted-phrase> or subject:/<regex>/
+              Any  term  prefixed  with subject: will match only text from the
+              subject of an email. Searching for a phrase in  the  subject  is
+              supported  by including quotation marks around the phrase, imme‐
+              diately following subject:.
+
+       attachment:<word>
+              The attachment: prefix can be used to search for specific  file‐
+              names (or extensions) of attachments to email messages.
+
+       mimetype:<word>
+              The  mimetype:  prefix  will be used to match text from the con‐
+              tent-types of MIME parts within email messages (as specified  by
+              the sender).
+
+       tag:<tag> or tag:/<regex>/ or is:<tag> or is:/<regex>/
+              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.
+
+       id:<message-id> or mid:<message-id> or mid:/<regex>/
+              For  id: and mid:, message ID values are the literal contents of
+              the Message-ID: header of email messages, but without  the  '<',
+              '>' delimiters.
+
+       thread:<thread-id>
+              The  thread:  prefix  can be used with the thread ID values that
+              are generated internally by notmuch (and do not appear in  email
+              messages).  These thread ID values can be seen in the first col‐
+              umn of output from notmuch search
+
+       path:<directory-path> or path:<directory-path>/** or path:/<regex>/
+              The path: prefix searches for email messages that are in partic‐
+              ular  directories  within  the mail store. The directory must be
+              specified relative to the top-level  maildir  (and  without  the
+              leading slash). By default, path: matches messages in the speci‐
+              fied directory only. The "/**" suffix can be used to match  mes‐
+              sages  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.
+
+              path:  will find a message if any copy of that message is in the
+              specific directory.
+
+       folder:<maildir-folder> or folder:/<regex>/
+              The folder: prefix searches for email messages by maildir or  MH
+              folder.  For  MH-style folders, this is equivalent to path:. For
+              maildir, this includes messages in the "new" and "cur" subdirec‐
+              tories.  The  exact  syntax  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 folders 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.
+
+              folder:  will  find  a message if any copy of that message is in
+              the specific folder.
+
+       date:<since>..<until> or date:<date>
+              The date: prefix can be used to restrict  the  results  to  only
+              messages  within  a  particular  time  range (based on the Date:
+              header).
+
+              See DATE AND TIME SEARCH below for details on the range  expres‐
+              sion, and supported syntax for <since> and <until> date and time
+              expressions.
+
+              The time range can also be specified  using  timestamps  with  a
+              syntax of:
+
+              <initial-timestamp>..<final-timestamp>
+
+              Each  timestamp  is  a number representing the number of seconds
+              since 1970-01-01 00:00:00 UTC.
+
+       lastmod:<initial-revision>..<final-revision>
+              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  conjunction with the --uuid argument to notmuch search
+              to find messages that have changed since an earlier query.
+
+       query:<name>
+              The query: prefix allows queries to refer  to  previously  saved
+              queries  added  with  notmuch-config(1).  Named queries are only
+              available if notmuch is built with Xapian Field Processors  (see
+              below).
+
+       property:<key>=<value>
+              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.  See notmuch-properties(7) for more details.
 

  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
@@ -184,7 +180,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
@@ -198,28 +194,28 @@
           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. Certain special prefixes are processed
-       by notmuch in a way not stricly fitting either  of  Xapian's  built  in
+       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 strictly fitting either of Xapian's built in
        styles. The prefixes currently supported by notmuch are as follows.
 
        Boolean
@@ -234,11 +230,11 @@
 
 

  Terms and phrases

-       In  general  Xapian  distinguishes  between lists of 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.
+       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 equivalent ways to write the same phrase.
 
        · "a list of words"
 
@@ -249,7 +245,7 @@
        · 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
+       bilistic prefixes such as to:, from:, and subject:. In particular
 
           subject:(pizza free)
 
@@ -266,11 +262,11 @@
 
 

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.
 
@@ -278,29 +274,29 @@
        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.
 
-       date:<expr>..! can be used as a shorthand for date:<expr>..<expr>.  The
-       expansion  takes  place  before  interpretation, and thus, for example,
-       date:monday..! matches from the beginning of Monday until  the  end  of
-       Monday.   With  Xapian  Field  Processor support (see below), non-range
-       date queries such as date:yesterday will work, but otherwise will  give
+       date:<expr>..!  can be used as a shorthand for date:<expr>..<expr>. The
+       expansion takes place before interpretation,  and  thus,  for  example,
+       date:monday..!  matches  from  the beginning of Monday until the end of
+       Monday.  With Xapian Field Processor  support  (see  below),  non-range
+       date  queries such as date:yesterday will work, but otherwise will give
        unexpected results; if in doubt use date:yesterday..!
 
-       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.
 
@@ -312,15 +308,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 @@ -381,9 +377,9 @@

XAPIAN FIELD PROCESSORS

-       Certain  optional  features  of the notmuch query processor rely on the
-       presence of the Xapian field processor API. You can determine  if  your
-       notmuch  was  built  against a sufficiently recent version of Xapian by
+       Certain optional features of the notmuch query processor  rely  on  the
+       presence  of  the Xapian field processor API. You can determine if your
+       notmuch was built against a sufficiently recent version  of  Xapian  by
        running
 
           % notmuch config get built_with.field_processor
@@ -399,9 +395,10 @@
 
 

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(1), notmuch-show(1), notmuch-tag(1)
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       much-hooks(5), notmuch-insert(1),  notmuch-new(1),  notmuch-reindex(1),
+       notmuch-properties(1),   *notmuch-reply(1),   notmuch-restore(1),  not‐
+       much-search(1), *notmuch-show(1), notmuch-tag(1)
 

AUTHOR

@@ -411,7 +408,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index ae3e988..4902b5a 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -25,136 +25,141 @@ Supported options for show include - --entire-thread=(true|false) - If true, notmuch show outputs all messages in the thread of - any message matching the search terms; if false, it outputs - only the matching messages. For --format=json and --for- - mat=sexp this defaults to true. For other formats, this - defaults to false. - - --format=(text|json|sexp|mbox|raw) - - text (default for messages) - The default plain-text format has all text-content MIME - parts decoded. Various components in the output, (mes- - sage, header, body, attachment, and MIME part), will be - delimited by easily-parsed markers. Each marker consists - of a Control-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 + --entire-thread=(true|false) + If true, notmuch show outputs all messages in the thread of any + message matching the search terms; if false, it outputs only the + matching messages. For --format=json and --format=sexp this + defaults to true. For other formats, this defaults to false. + + --format=(text|json|sexp|mbox|raw) + + text (default for messages) + The default plain-text format has all text-content MIME + parts decoded. Various components in the output, (mes- + sage, header, body, attachment, and MIME part), will be + delimited by easily-parsed markers. Each marker consists + of a Control-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 multipart MIME message, these parts will be nested. - json 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 multi‐ + json 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 multi‐ part MIME messages is reflected in nested JSON output. By - default JSON output includes all messages in a matching - thread; that is, by default, --format=json sets + default JSON output includes all messages in a matching + thread; that is, by default, --format=json sets --entire-thread. The caller can disable this behaviour by setting --entire-thread=false. The JSON output is always - encoded as UTF-8 and any message content included in the + encoded as UTF-8 and any message content included in the output will be charset-converted to UTF-8. - sexp The output is formatted as the Lisp s-expression (sexp) - equivalent of the JSON format above. Objects are format‐ - ted as property lists whose keys are keywords (symbols - preceded by a colon). True is formatted as t and both - false and null are formatted as nil. As for JSON, the + sexp The output is formatted as the Lisp s-expression (sexp) + equivalent of the JSON format above. Objects are format‐ + ted as property lists whose keys are keywords (symbols + preceded by a colon). True is formatted as t and both + false and null are formatted as nil. As for JSON, the s-expression output is always encoded as UTF-8. mbox 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 + 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 + 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 - http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - - raw (default if --part is given) - Write the raw bytes of the given MIME part of a message + raw (default if --part is given) + Write the raw bytes of the given MIME part of a message to standard out. For this format, it is an error to spec‐ ify a query that matches more than one message. - If the specified part is a leaf part, this outputs the + If the specified part is a leaf part, this outputs the body of the part after performing content transfer decod‐ - ing (but no charset conversion). This is suitable for + ing (but no charset conversion). This is suitable for saving attachments, for example. - For a multipart or message part, the output includes the - part headers as well as the body (including all child - parts). No decoding is performed because multipart and - message parts cannot have non-trivial content transfer - encoding. Consumers of this may need to implement MIME + For a multipart or message part, the output includes the + part headers as well as the body (including all child + parts). No decoding is performed because multipart and + message parts cannot have non-trivial content transfer + encoding. Consumers of this may need to implement MIME decoding and similar functions. - --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. - - --part=N - 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 - structure, and are identified in the 'json', 'sexp' or 'text' - output formats. - - Note that even a message with no MIME structure or a single - body part still has two MIME parts: part 0 is the whole mes‐ - sage (headers and body) and part 1 is just the body. - - --verify - Compute and report the validity of any MIME cryptographic - signatures found in the selected content (ie. "multi‐ - part/signed" parts). Status of the signature will be reported - (currently only supported with --format=json and --for‐ - mat=sexp), and the multipart/signed part will be replaced by - the signed data. - - --decrypt - Decrypt any MIME encrypted parts found in the selected con‐ - tent (ie. "multipart/encrypted" parts). Status of the decryp‐ - tion will be reported (currently only supported with --for‐ - mat=json and --format=sexp) and on successful decryption the - multipart/encrypted part will be replaced by the decrypted - content. - - Decryption expects a functioning gpg-agent(1) to provide any - needed credentials. Without one, the decryption will fail. - - Implies --verify. - - --exclude=(true|false) - Specify whether to omit threads only matching - search.tag_exclude 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 - returned regardless (with the excluded flag being set when - appropriate) but threads that only match in an excluded mes‐ - sage are not returned when --exclude=true. - - The default is --exclude=true. - - --body=(true|false) - If true (the default) notmuch show includes the bodies of the - messages in the output; if false, bodies are omitted. - --body=false is only implemented for the json and sexp for‐ - mats and it is incompatible with --part > 0. - - This is useful if the caller only needs the headers as - body-less output is much faster and substantially smaller. - - --include-html - Include "text/html" parts as part of the output (currently - only supported with --format=json and --format=sexp). By - default, unless --part=N is used to select a specific part or - --include-html is used to include all "text/html" parts, no - part with content type "text/html" is included in the output. + --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. + + --part=N + 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 structure, + and are identified in the 'json', 'sexp' or 'text' output for‐ + mats. + + Note that even a message with no MIME structure or a single body + part still has two MIME parts: part 0 is the whole message + (headers and body) and part 1 is just the body. + + --verify + Compute and report the validity of any MIME cryptographic signa‐ + tures found in the selected content (ie. "multipart/signed" + parts). Status of the signature will be reported (currently only + supported with --format=json and --format=sexp), and the multi‐ + part/signed part will be replaced by the signed data. + + --decrypt=(false|auto|true) + If true, decrypt any MIME encrypted parts found in the selected + content (i.e. "multipart/encrypted" parts). Status of the + decryption will be reported (currently only supported with + --format=json and --format=sexp) and on successful decryption + the multipart/encrypted part will be replaced by the decrypted + content. + + If auto, and a session key is already known for the message, + then it will be decrypted, but notmuch will not try to access + the user's keys. + + Use false to avoid even automatic decryption. + + Non-automatic decryption expects a functioning gpg-agent(1) to + provide any needed credentials. Without one, the decryption will + fail. + + Note: true implies --verify. + + Default: auto + + --exclude=(true|false) + Specify whether to omit threads only matching search.tag_exclude + 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 + returned regardless (with the excluded flag being set when + appropriate) but threads that only match in an excluded message + are not returned when --exclude=true. + + The default is --exclude=true. + + --body=(true|false) + If true (the default) notmuch show includes the bodies of the + messages in the output; if false, bodies are omitted. + --body=false is only implemented for the json and sexp formats + and it is incompatible with --part > 0. + + This is useful if the caller only needs the headers as body-less + output is much faster and substantially smaller. + + --include-html + Include "text/html" parts as part of the output (currently only + supported with --format=json and --format=sexp). By default, + unless --part=N is used to select a specific part or + --include-html is used to include all "text/html" parts, no part + with content type "text/html" is included in the output. A common use of notmuch show is to display a single thread of email messages. For this, use a search term of "thread:<thread-id>" as can be @@ -185,7 +190,7 @@

COPYRIGHT

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

0.24

+

0.26

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index f6873a1..354ce46 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -35,23 +35,22 @@ Supported options for tag include - --remove-all - Remove all tags from each message matching the search terms - before applying the tag changes appearing on the command - line. This means setting the tags of each message to the - tags to be added. If there are no tags to be added, the mes‐ - sages will have no tags. - - --batch - Read batch tagging operations from a file (stdin by default). - This is more efficient than repeated notmuch tag invocations. - See TAG FILE FORMAT below for the input format. This option - is not compatible with specifying tagging on the command - line. - - --input=<filename> - Read input from given file, instead of from stdin. Implies - --batch. + --remove-all + Remove all tags from each message matching the search terms + before applying the tag changes appearing on the command line. + This means setting the tags of each message to the tags to be + added. If there are no tags to be added, the messages will have + no tags. + + --batch + Read batch tagging operations from a file (stdin by default). + This is more efficient than repeated notmuch tag invocations. + See TAG FILE FORMAT below for the input format. This option is + not compatible with specifying tagging on the command line. + + --input=<filename> + Read input from given file, instead of from stdin. Implies + --batch.

TAG FILE FORMAT

@@ -60,21 +59,21 @@ +<tag>|-<tag> [...] [--] <query> - Each line is interpreted similarly to notmuch tag command line argu‐ + Each line is interpreted similarly to notmuch tag command line argu‐ ments. The delimiter is one or more spaces ' '. Any characters in <tag> - may be hex-encoded with %NN where NN is the hexadecimal value of the - character. To hex-encode a character with a multi-byte UTF-8 encoding, - hex-encode each byte. Any spaces in <tag> must be hex-encoded as %20. + may be hex-encoded with %NN where NN is the hexadecimal value of the + character. To hex-encode a character with a multi-byte UTF-8 encoding, + hex-encode each byte. Any spaces in <tag> must be hex-encoded as %20. Any characters that are not part of <tag> must not be hex-encoded. - In the future tag:"tag with spaces" style quoting may be supported for - <tag> as well; for this reason all double quote characters in <tag> + In the future tag:"tag with spaces" style quoting may be supported for + <tag> as well; for this reason all double quote characters in <tag> should be hex-encoded. - The <query> should be quoted using Xapian boolean term quoting rules: - if a term contains whitespace or a close paren or starts with a double - quote, it must be enclosed in double quotes (not including any prefix) - and double quotes inside the term must be doubled (see below for exam‐ + The <query> should be quoted using Xapian boolean term quoting rules: + if a term contains whitespace or a close paren or starts with a double + quote, it must be enclosed in double quotes (not including any prefix) + and double quotes inside the term must be doubled (see below for exam‐ ples). Leading and trailing space ' ' is ignored. Empty lines and lines begin‐ @@ -83,8 +82,8 @@

  EXAMPLE

-       The  following shows a valid input to batch tagging. Note that only the
-       isolated '*' acts as a wildcard. Also note the two  different  quotings
+       The following shows a valid input to batch tagging. Note that only  the
+       isolated  '*'  acts as a wildcard. Also note the two different quotings
        of the tag space in tags
 
           +winner *
@@ -101,8 +100,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-search-terms(7),  not‐
        much-show(1),
 
@@ -114,7 +113,7 @@

COPYRIGHT

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

0.24

+

0.26

-- 2.43.0