From: Tomi Ollila Date: Mon, 4 Aug 2014 07:15:07 +0000 (+0300) Subject: 0.18.1 namual pages -- latest man-to-mdwn.pl & man(1) X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=commitdiff_plain;h=6562766d20047abcb3bab0d88a1e5849baaae76d 0.18.1 namual pages -- latest man-to-mdwn.pl & man(1) --- diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index dbf4b8c..5a276e5 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -12,7 +12,7 @@

DESCRIPTION

-       Notmuch  is a command-line based program for indexing, searching, read-
+       Notmuch  is a command-line based program for indexing, searching, read‐
        ing, and tagging large collections of email messages.
 
        This page describes how to get started using notmuch from  the  command
@@ -21,16 +21,16 @@
        also accessible via notmuch help show
 
        The  quickest  way  to get started with Notmuch is to simply invoke the
-       notmuch command with no arguments, which will interactively  guide  you
+       notmuch command with no arguments, which will interactively  guide  you
        through the process of indexing your mail.

NOTE

-       While the command-line program notmuch provides powerful functionality,
-       it does not provide the most convenient interface for that  functional-
+       While the command-line program notmuch provides powerful functionality,
+       it does not provide the most convenient interface for that  functional‐
        ity.  More  sophisticated interfaces are expected to be built on top of
-       either the command-line interface, or more likely, on top of  the  not-
+       either the command-line interface, or more likely, on top of  the  not‐
        much  library  interface.  See  http://notmuchmail.org  for  more about
        alternate interfaces to notmuch. The emacs-based interface  to  notmuch
        (available under emacs/ in the Notmuch source distribution) is probably
@@ -39,20 +39,16 @@
 
 
OPTIONS

 
-       Supported global options for notmuch include
+       Supported global options for notmuch include
 
-           --help
+          --help Print a synopsis of available commands and exit.
 
-                  Print a synopsis of available commands and exit.
+          --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
+                 configuration file specified by ${NOTMUCH_CONFIG}.
 

 
 
COMMANDS

@@ -63,36 +59,36 @@
        (or to reconfigure it later).
 
        The setup command will prompt for your full name,  your  primary  email
-       address,  any alternate email addresses you use, and the directory con-
-       taining your email archives. Your answers will be written to a configu-
+       address,  any alternate email addresses you use, and the directory con‐
+       taining your email archives. Your answers will be written to a configu‐
        ration  file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
-       This configuration file will be created with descriptive comments, mak-
+       This configuration file will be created with descriptive comments, mak‐
        ing  it  easy to edit by hand later to change the configuration. Or you
        can run notmuch setup again to change the configuration.
 
-       The mail directory you specify can contain any number  of  sub-directo-
-       ries and should primarily contain only files with individual email mes-
+       The mail directory you specify can contain any number  of  sub-directo‐
+       ries and should primarily contain only files with individual email mes‐
        sages (eg. maildir or mh archives are perfect).  If  there  are  other,
        non-email  files  (such  as indexes maintained by other email programs)
        then notmuch will do its best to detect those and ignore them.
 
        Mail storage that uses mbox format, (where one mbox file contains  many
-       messages),  will not work with notmuch. If that's how your mail is cur-
+       messages),  will not work with notmuch. If that's how your mail is cur‐
        rently stored, it is recommended you first convert it to maildir format
        with a utility such as mb2md before running notmuch setup .
 
-       Invoking  notmuch  with no command argument will run setup if the setup
+       Invoking  notmuch  with no command argument will run setup if the setup
        command has not previously been completed.

  OTHER COMMANDS

-       Several of the notmuch commands accept search terms with a common  syn-
-       tax. See notmuch-search-terms(7) for more details on the supported syn-
+       Several of the notmuch commands accept search terms with a common  syn‐
+       tax. See notmuch-search-terms(7) for more details on the supported syn‐
        tax.
 
-       The search, show and  count  commands  are  used  to  query  the  email
-       database.
+       The search, show and count commands are used to query the  email  data‐
+       base.
 
        The  reply  command  is  useful  for  preparing a template for an email
        reply.
@@ -113,18 +109,15 @@
        of notmuch.
 
        NOTMUCH_CONFIG
-
-              Specifies the location of the notmuch configuration  file.  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-
               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
               stderr) Xapian queries it constructs.
@@ -132,8 +125,8 @@

SEE ALSO

        notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-insert(1),      notmuch-new(1),      notmuch-reply(1),     not-
-       much-restore(1),   notmuch-search(1),   notmuch-search-terms(7),   not-
+       notmuch-insert(1),      notmuch-new(1),      notmuch-reply(1),     not‐
+       much-restore(1),   notmuch-search(1),   notmuch-search-terms(7),   not‐
        much-show(1), notmuch-tag(1)
 
        The notmuch website: http://notmuchmail.org
@@ -159,4 +152,4 @@
        2014, Carl Worth and many others
-

0.18

+

0.18.1

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index a806639..7bbda19 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -18,23 +18,21 @@ The compacted database is built in a temporary directory and is later moved into the place of the origin database. The original uncompacted - database is discarded, unless the --backup=<directory> option is used. + database is discarded, unless the --backup=<directory> option is used. - Note that the database write lock will be held during the compaction + Note that the database write lock will be held during the compaction process (which may be quite long) to protect data integrity. Supported options for compact include - --backup=<directory> + --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. - 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. - - --quiet - - Do not report database compaction progress to stdout. + --quiet + Do not report database compaction progress to stdout.

ENVIRONMENT

@@ -43,17 +41,16 @@ 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-
+       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)
@@ -67,4 +64,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 24d4a63..1b1235f 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -19,105 +19,91 @@ The config command can be used to get or set settings in the notmuch configuration file. - get + 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. - 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. + 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. - set + If no values are provided, the specified configuration item + will be removed from the configuration file. - 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 - separate line of the form: - - section.item=value - - No additional whitespace surrounds the dot or equals sign - characters. In a multiple-value item (a list), the values - are separated by semicolon characters. + No additional whitespace surrounds the dot or equals sign + characters. In a multiple-value item (a list), the values are + separated 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. - - user.name - - Your full name. - - user.primary_email - - Your primary email address. - - user.other_email - - A list of other email addresses at which you receive email. - - new.tags - - A list of tags that will be added to all messages incorpo- - rated by notmuch new. - - 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. - - 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. - - 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 file- - names and update tags, while the notmuch tag and notmuch - restore commands 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. + 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. + + user.name + Your full name. + + user.primary_email + Your primary email address. + + user.other_email + A list of other email addresses at which you receive email. + + new.tags + A list of tags that will be added to all messages incorpo‐ + rated by notmuch new. + + 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. + + 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. + + 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.

ENVIRONMENT

@@ -126,18 +112,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),
-       notmuch-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-show(1),   not‐
+       much-tag(1)

AUTHOR

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

0.18

+

0.18.1

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index ac92207..1eb513d 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -16,57 +16,49 @@ The number of matching messages (or threads) is output to stdout. - With no search terms, a count of all messages (or threads) in the - database will be displayed. + With no search terms, a count of all messages (or threads) in the data‐ + base will be displayed. See notmuch-search-terms(7) for details of the supported syntax for <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 default. threads - Output the number of matching threads. - files - - Output the number of files associated with matching mes- + files Output the number of files associated with matching mes‐ sages. This may be bigger than the number of matching 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. - - --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. + + --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-
+       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-
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -80,4 +72,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 7a94088..2caf278 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -22,24 +22,19 @@ therefore the only critical thing to backup (and much more friendly to incremental backup than the native database files.) - --gzip - - Compress the output in a format compatible with gzip(1). + --gzip Compress the output in a format compatible with gzip(1). --format=(sup|batch-tag) - Notmuch restore supports two plain text dump formats, both with one message-id per line, followed by a list of tags. batch-tag - The default batch-tag dump format is intended to more robust against malformed message-ids and tags containing whitespace or non-ascii(7) characters. Each line has the form - - +<encoded-tag> +<encoded-tag> ... -- id:<quoted-mes- - sage-id> + +<encoded-tag> +<encoded-tag> ... -- id:<quoted-mes‐ + sage-id> Tags are hex-encoded by replacing every byte not matching the regex [A-Za-z0-9@=.,_+-] with %nn where nn is the two @@ -49,38 +44,35 @@ 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 - batch input format for notmuch-tag(1); note that the sin- + 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> ... ) + <message-id> ( <tag> ... ) with zero or more tags are separated by spaces. Note that - (malformed) message-ids may contain arbitrary non-null - characters. Note also that tags with spaces will not be + (malformed) message-ids may contain arbitrary non-null + characters. Note also that tags with spaces will not be correctly restored with this format. - With no search terms, a dump of all messages in the database - will be generated. A "--" argument instructs notmuch that the + With no search terms, a dump of all messages in the database + will be generated. A "--" argument instructs notmuch that the remaining arguments are search terms. - See notmuch-search-terms(7) for details of the supported syntax + See notmuch-search-terms(7) for details of the supported syntax for <search-terms>.

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-
+       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)
@@ -94,4 +86,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index d42bfcd..873fd90 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

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

DESCRIPTION

@@ -19,32 +19,30 @@ The currently available hooks are described below. - pre-new + 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. - 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 process- - ing 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.

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-insert(1),  notmuch-new(1),  notmuch-reply(1), notmuch-restore(1),
-       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not-
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -58,4 +56,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 0cb24e3..fdaa55a 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -14,7 +14,7 @@ 
        notmuch insert reads a message from standard input and delivers it into
        the maildir directory given by configuration option database.path, then
-       incorporates  the  message into the notmuch database. It is an alterna-
+       incorporates  the  message into the notmuch database. It is an alterna‐
        tive to using a separate tool to deliver the message then running  not-
        much new afterwards.
 
@@ -22,31 +22,29 @@
        configuration option, then by operations specified on the command-line:
        tags prefixed by '+' are added while those prefixed by '-' are removed.
 
-       If the new message is  a  duplicate  of  an  existing  message  in  the
-       database  (it  has  same  Message-ID),  it will be added to the maildir
-       folder and notmuch database, but the tags will not be changed.
+       If  the  new message is a duplicate of an existing message in the data‐
+       base (it has same Message-ID), it will be added to the  maildir  folder
+       and notmuch database, but the tags will not be changed.
 
-       Option arguments must appear before any tag operation arguments.   Sup-
+       Option  arguments must appear before any tag operation arguments.  Sup‐
        ported options for insert include
 
-           --folder=<folder>
+          --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.
 
-                  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.
+          --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.

EXIT STATUS

-       This  command  returns  exit  status  0 if the message was successfully
-       added to the mail directory, even if the message could not  be  indexed
-       and  added  to the notmuch database. In the latter case, a warning will
+       This command returns exit status 0  if  the  message  was  successfully
+       added  to  the mail directory, even if the message could not be indexed
+       and added to the notmuch database. In the latter case, a  warning  will
        be printed to standard error but the message file will be left on disk.
 
        If the message could not be written to disk then a non-zero exit status
@@ -55,7 +53,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)
 

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

0.18

+

0.18.1

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index dfa370c..e17a0d0 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -22,15 +22,15 @@ create the initial database. The first run may take a long time if you have a significant amount of mail (several hundred thousand messages or more). Subsequently, you should run notmuch new whenever new mail is - delivered and you wish to incorporate it into the database. These sub- + delivered and you wish to incorporate it into the database. These sub‐ sequent runs will be much quicker than the initial run. - Invoking notmuch with no command argument will run new if notmuch setup + Invoking notmuch with no command argument will run new if notmuch setup has previously been completed, but notmuch new has not previously been run. notmuch new updates tags according to maildir flag changes if the - maildir.synchronize_flags configuration option is enabled. See not- + maildir.synchronize_flags configuration option is enabled. See not‐ much-config(1) for details. The new command supports hooks. See notmuch-hooks(5) for more details @@ -38,20 +38,18 @@ Supported options for new include - --no-hooks + --no-hooks + Prevents hooks from being run. - Prevents hooks from being run. - - --quiet - - Do not print progress or results. + --quiet + Do not print progress or results.

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-
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -65,4 +63,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index dcfe28b..0649d23 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -17,7 +17,7 @@ To make replying to email easier, notmuch reply takes an existing set of messages and constructs a suitable mail template. The Reply-to: header (if any, otherwise From:) is used for the To: address. Unless - --reply-to=sender is specified, values from the To: and Cc: headers are + --reply-to=sender is specified, values from the To: and Cc: headers are copied, but not including any of the current user's email addresses (as configured in primary_mail or other_email in the .notmuch-config file) in the recipient list. @@ -33,74 +33,62 @@ 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 message. - json - - Produces JSON output containing headers for a reply mes- - sage and the contents of the original message. This out- + json Produces JSON output containing headers for a reply mes‐ + sage and the contents of the original message. This out‐ put can be used by a client to create a reply message intelligently. - sexp - - Produces S-Expression output containing headers for a + sexp Produces S-Expression output containing headers for a reply message and the contents of the original message. This output can be used by a client to create a reply message intelligently. headers-only - 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) - Replies to all addresses. - sender - - Replies only to the sender. If replying to user's own + sender Replies only to the sender. If replying to user's own message (Reply-to: or From: header is one of the user's - configured email addresses), try To:, Cc:, and Bcc: head- + configured email addresses), try To:, Cc:, and Bcc: head‐ ers in this order, and copy values from the first that - contains something other than only the user's addresses. - - --decrypt + contains something other than only the user's addresses. - Decrypt any MIME encrypted parts found in the selected con- - tent (ie. "multipart/encrypted" parts). Status of the - decryption will be reported (currently only supported with - --format=json and --format=sexp) and on successful decryp- - tion the multipart/encrypted part will be replaced by the - decrypted content. + --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. + Decryption expects a functioning gpg-agent(1) to provide any + needed credentials. Without one, the decryption will fail. - See notmuch-search-terms(7) for details of the supported syntax for + See notmuch-search-terms(7) for details of the supported syntax for <search-terms>. - Note: It is most common to use notmuch reply with a search string - matching a single message, (such as id:<message-id>), but it can be + Note: It is most common to use notmuch reply with a search string + matching a single message, (such as id:<message-id>), but it can be useful to reply to several messages at once. For example, when a series - of patches are sent in a single thread, replying to the entire thread - allows for the reply to comment on issues found in multiple patches. - The default format supports replying to multiple messages at once, but + of patches are sent in a single thread, replying to the entire thread + allows for the reply to comment on issues found in multiple patches. + The default format supports replying to multiple messages at once, but the JSON and S-Expression formats do not. @@ -108,20 +96,16 @@ 
        This command supports the following special exit status codes
 
-       20
-
-              The requested format version is too old.
-
-       21
+       20     The requested format version is too old.
 
-              The requested format version is too new.
+       21     The requested format version is too new.

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not-
-       much-hooks(5), notmuch-insert(1),  notmuch-new(1),  notmuch-restore(1),
-       notmuch-search(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-restore(1),
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -135,4 +119,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 78356b1..225affc 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -20,60 +20,53 @@ 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 con- - figuration 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. + --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.

GZIPPED INPUT

-       notmuch restore will detect if the input is compressed in gzip(1)  for-
+       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-
+       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-
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -87,4 +80,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index b3afd65..53bdbb7 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -17,7 +17,7 @@ The output consists of one line per thread, giving a thread ID, the date of the newest (or oldest, depending on the sort option) matched - message in the thread, the number of matched messages and total mes- + message in the thread, the number of matched messages and total mes‐ sages in the thread, the names of all participants in the thread, and the subject of the newest (or oldest) message. @@ -26,147 +26,129 @@ Supported options for search include - --format=(json|sexp|text|text0) + --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). - 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. - --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- + 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. threads - Output the thread IDs of all threads with any message - matching the search terms, either one per line (--for- + 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 (--format=sexp). messages - Output the message IDs of all messages matching the - search terms, either one per line (--format=text), sepa- + 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- + array (--format=json), or as an S-Expression list (--for‐ mat=sexp). - files - - Output the filenames of all messages matching the search + 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- + 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- + 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- + 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 search. - tags - - Output all tags that appear on any message matching the - search terms, either one per line (--format=text), sepa- + 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- + 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 - - Effective with --output=files, output the Nth filename asso- - ciated with each message matching the query (N is 1-based). - If N is greater than the number of files associated with the - message, don't print anything. - - 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 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 + Effective with --output=files, output the Nth filename asso‐ + ciated with each message matching the query (N is 1-based). + If N is greater than the number of files associated with the + message, don't print anything. + + 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.

EXIT STATUS

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

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-new(1),   notmuch-reply(1),
-       notmuch-restore(1),   notmuch-search-terms(7),   notmuch-show(1),  not-
+       notmuch-restore(1),   notmuch-search-terms(7),   notmuch-show(1),  not‐
        much-tag(1)
@@ -180,4 +162,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index 98e15c7..61539a6 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -25,7 +25,7 @@ The search terms can consist of free-form text (and quoted phrases) which will match all messages that contain all of the given - terms/phrases in the body, the subject, or any of the sender or recipi- + terms/phrases in the body, the subject, or any of the sender or recipi‐ ent headers. As a special case, a search string consisting of exactly a single @@ -76,13 +76,13 @@ 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- + 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- + 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 @@ -90,19 +90,19 @@ 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 + 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 + Both path: and folder: will find a message if any copy of that message is in the specific directory/folder. - The date: prefix can be used to restrict the results to only messages + The date: prefix can be used to restrict the results to only messages within a particular time range (based on the Date: header) with a range syntax of: @@ -132,8 +132,8 @@

DATE AND TIME SEARCH

-       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-
+       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
@@ -150,7 +150,7 @@
        <since> and <until> can describe imprecise times, such as  "yesterday".
        In  this  case, <since> is taken as the earliest time it could describe
        (the beginning of yesterday) and <until> is taken as the latest time it
-       could  describe (the end of yesterday). Similarly, date:january..febru-
+       could  describe (the end of yesterday). Similarly, date:january..febru‐
        ary matches from the beginning of January to the end of February.
 
        Currently, we do not support  spaces  in  range  expressions.  You  can
@@ -158,7 +158,7 @@
        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-
+       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.
@@ -171,7 +171,7 @@
 
 
   Relative date and time

 
-       [N|number]         (years|months|weeks|days|hours|hrs|minutes|mins|sec-
+       [N|number]         (years|months|weeks|days|hours|hrs|minutes|mins|sec‐
        onds|secs) [...]
 
        All refer to past, can be repeated and will be accumulated.
@@ -245,7 +245,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-insert(1),  notmuch-new(1),   notmuch-reply(1),
        notmuch-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1)
 

@@ -260,4 +260,4 @@
        2014, Carl Worth and many others
 

 
-
0.18

+
0.18.1

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn
index dc649f8..001f9e5 100644
--- a/manpages/notmuch-show-1.mdwn
+++ b/manpages/notmuch-show-1.mdwn
@@ -18,25 +18,23 @@
        <search-terms>.
 
        The messages will be grouped and sorted based  on  the  threading  (all
-       replies to a particular message will appear immediately after that mes-
+       replies to a particular message will appear immediately after that mes‐
        sage in date order). The output is not indented by default,  but  depth
        tags  are  printed  so  that  proper  indentation can be performed by a
        post-processor (such as the emacs interface to notmuch).
 
        Supported options for show include
 
-           --entire-thread=(true|false)
+          --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.
 
-                  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)
+          --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
@@ -46,31 +44,25 @@
                      ('{' 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   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-
+                     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
-                     --entire-thread. The caller can disable this behaviour by
-                     setting --entire-thread=false.  The JSON output is always
+                     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
                      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-
+              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
+                     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   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
@@ -81,13 +73,12 @@
                      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
-                     to standard out. For this format, it is an error to spec-
+                     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
-                     body of the part after performing content transfer decod-
+                     body of the part after performing content transfer decod‐
                      ing (but no charset conversion).  This  is  suitable  for
                      saving attachments, for example.
 
@@ -98,82 +89,74 @@
                      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
-                  --format=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
-                  decryption  will  be reported (currently only supported with
-                  --format=json and --format=sexp) and on  successful  decryp-
-                  tion  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.
-
-       A  common  use  of  notmuch show is to display a single thread of email
+          --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.
+
+       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
        seen in the first column of output from the notmuch search command.
@@ -182,20 +165,16 @@ 
        This command supports the following special exit status codes
 
-       20
-
-              The requested format version is too old.
-
-       21
+       20     The requested format version is too old.
 
-              The requested format version is too new.
+       21     The requested format version is too new.

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not-
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1),   notmuch-reply(1),
-       notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  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(1),  notmuch-search-terms(7),  not‐
        much-tag(1)
@@ -209,4 +188,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 5685a39..19c2775 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -30,31 +30,28 @@ specify a "--" argument to separate the tags from the search terms. notmuch tag updates the maildir flags according to tag changes if the - maildir.synchronize_flags configuration option is enabled. See not- + maildir.synchronize_flags configuration option is enabled. See not‐ much-config(1) for details. 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 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.

TAG FILE FORMAT

@@ -63,7 +60,7 @@ +<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, @@ -77,10 +74,10 @@ 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- + 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- + Leading and trailing space ' ' is ignored. Empty lines and lines begin‐ ning with '#' are ignored. @@ -90,23 +87,23 @@ isolated '*' acts as a wildcard. Also note the two different quotings of the tag space in tags - +winner * - +foo::bar%25 -- (One and Two) or (One and tag:winner) - +found::it -- tag:foo::bar% - # ignore this line and the next + +winner * + +foo::bar%25 -- (One and Two) or (One and tag:winner) + +found::it -- tag:foo::bar% + # ignore this line and the next - +space%20in%20tags -- Two - # add tag '(tags)', among other stunts. - +crazy{ +(tags) +&are +#possible\ -- tag:"space in tags" - +match*crazy -- tag:crazy{ - +some_tag -- id:"this is ""nauty)""" + +space%20in%20tags -- Two + # add tag '(tags)', among other stunts. + +crazy{ +(tags) +&are +#possible\ -- tag:"space in tags" + +match*crazy -- tag:crazy{ + +some_tag -- id:"this is ""nauty)"""

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-new(1),   notmuch-reply(1),
-       notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  not-
+       notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  not‐
        much-show(1),
@@ -120,4 +117,4 @@ 2014, Carl Worth and many others -

0.18

+

0.18.1