From 0add150ffd941ea7ed64a9116929aaf2daa927a5 Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Tue, 6 May 2014 12:34:35 +0300 Subject: [PATCH] manpages, tweaked man-to-mdwm.pl a bit to make this work. some post-hand-editing required... --- manpages.mdwn | 29 ++- manpages/notmuch-1.mdwn | 49 +++-- manpages/notmuch-compact-1.mdwn | 35 ++-- manpages/notmuch-config-1.mdwn | 144 ++++++++------- manpages/notmuch-count-1.mdwn | 65 ++++--- manpages/notmuch-dump-1.mdwn | 98 +++++----- manpages/notmuch-hooks-5.mdwn | 44 +++-- manpages/notmuch-insert-1.mdwn | 32 ++-- manpages/notmuch-new-1.mdwn | 34 ++-- manpages/notmuch-reply-1.mdwn | 93 ++++++---- manpages/notmuch-restore-1.mdwn | 84 +++++---- manpages/notmuch-search-1.mdwn | 191 +++++++++++--------- manpages/notmuch-search-terms-7.mdwn | 245 ++++++++++++++----------- manpages/notmuch-setup-1.mdwn | 149 ---------------- manpages/notmuch-show-1.mdwn | 258 +++++++++++++++------------ manpages/notmuch-tag-1.mdwn | 78 ++++---- 16 files changed, 858 insertions(+), 770 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index 9671c26..f44015b 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -1,18 +1,17 @@ Manual page index ================= -* notmuch(1) - thread-based email index, search, and tagging -* notmuch-compact(1) - compact the notmuch database -* notmuch-config(1) - access notmuch configuration file -* notmuch-count(1) - count messages matching the given search terms -* notmuch-dump(1) - creates a plain-text dump of the tags of each message -* notmuch-insert(1) - add a message to the maildir and notmuch database -* notmuch-new(1) - incorporate new mail into the notmuch database -* notmuch-reply(1) - constructs a reply template for a set of messages -* 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-setup(1) - thread-based email index, search, and tagging -* 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-search-terms(7) - syntax for notmuch queries +* notmuch("1") - thread-based email index, search, and tagging +* notmuch-compact("1") - compact the notmuch database +* notmuch-config("1") - access notmuch configuration file +* notmuch-count("1") - count messages matching the given search terms +* notmuch-dump("1") - creates a plain-text dump of the tags of each message +* notmuch-insert("1") - add a message to the maildir and notmuch database +* notmuch-new("1") - incorporate new mail into the notmuch database +* notmuch-reply("1") - constructs a reply template for a set of messages +* 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-search-terms("7") - syntax for notmuch queries diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 3db4c8a..dbf4b8c 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch [option ...] command [arg ...]
+       notmuch [option ...] command [arg ...]

DESCRIPTION

@@ -17,21 +17,21 @@ This page describes how to get started using notmuch from the command line, and gives a brief overview of the commands available. For more - information on e.g. notmuch show consult the notmuch-show(1) man page, + information on e.g. notmuch show consult the notmuch-show(1) man page, 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,
+       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-
-       much  library  interface.  See  http://notmuchmail.org  for  more about
+       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
        the most widely used at this time.
@@ -39,20 +39,20 @@
 
 
OPTIONS

 
-       Supported global options for notmuch include
+       Supported global options for notmuch include
 
            --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.
+                  Print the installed version of notmuch, and exit.
 
            --config=FILE
 
-               Specify the configuration file to use. This overrides any  con-
-               figuration file specified by ${NOTMUCH_CONFIG}.
+                  Specify the configuration file to use.  This  overrides  any
+                  configuration file specified by ${NOTMUCH_CONFIG}.
 

 
 
COMMANDS

@@ -81,14 +81,14 @@
        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-
+       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
@@ -103,7 +103,7 @@
        The  dump  and restore commands can be used to create a textual dump of
        email tags for backup purposes, and to restore from that dump.
 
-       The config command can be used to get or set settings int  the  notmuch
+       The config command can be used to get or set settings  in  the  notmuch
        configuration file.
@@ -113,15 +113,18 @@ of notmuch. NOTMUCH_CONFIG + 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. @@ -129,9 +132,9 @@

SEE ALSO

        notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-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-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
@@ -139,11 +142,21 @@

CONTACT

        Feel  free to send questions, comments, or kudos to the notmuch mailing
-       list <notmuch@notmuchmail.org> . Subscription is  not  required  before
+       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
        (server: irc.freenode.net, channel: #notmuch).
-

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index d93f7dc..b9c846b 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -7,34 +7,34 @@

SYNOPSIS

-       notmuch compact [ --quiet ] [ --backup=<directory> ]
+       notmuch compact [--quiet] [--backup=<directory>]

DESCRIPTION

-       The  compact  command can be used to compact the notmuch database. This
+       The  compact command can be used to compact the notmuch database.  This
        can both reduce the space required by the database and  improve  lookup
        performance.
 
        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
        process (which may be quite long) to protect data integrity.
 
        Supported options for compact include
 
-           --backup=<directory>
+           --backup=<&lt;directory>&gt;
 
-               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.
+                  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.
+                  Do not report database compaction progress to stdout.

ENVIRONMENT

@@ -43,6 +43,7 @@ of notmuch. NOTMUCH_CONFIG + Specifies the location of the notmuch configuration file. Not- much will use ${HOME}/.notmuch-config if this variable is not set. @@ -52,8 +53,18 @@ 
        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-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not-
+       much-tag(1)
+
+ +

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 1f7283e..3b21e38 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -19,84 +19,95 @@ The config command can be used to get or set settings in the notmuch configuration file. - 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. + get - 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. + 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. - 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. + + If no values are provided, the specified configuration item + will be removed from the configuration file. list - Every configuration item is printed to stdout, each on a sepa- - rate line of the form: - section.item=value + 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 char- - acters. In a multiple-value item (a list), the values are sepa- - rated 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 .not- - much. + + 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. + + Your full name. user.primary_email - Your primary email address. + + Your primary email address. user.other_email - A list of other email addresses at which you receive 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 incorporated - by notmuch new. + + 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. + + 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. + + 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 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. + + If true, then the following maildir flags (in message file- + names) will be synchronized with the corresponding notmuch + tags: + + center; |l|l|. _ T{ Flag T} T{ Tag T} _ T{ D T} T{ + draft T} _ T{ F T} T{ flagged T} _ T{ P T} T{ passed T} + _ T{ R T} T{ replied T} _ T{ S T} T{ unread (added when + 'S' flag is not present) T} _ + + 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.

ENVIRONMENT

@@ -105,17 +116,28 @@ 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

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index e5e7812..378348d 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch count [options... ] <search-term>...
+       notmuch count [option ...] <search-term> ...

DESCRIPTION

@@ -24,49 +24,60 @@ Supported options for count include - --output=(messages|threads|files) + --output=(messages|threads|files) - messages + messages - Output the number of matching messages. This is the - default. + Output the number of matching messages. This is the + default. - threads + threads - Output the number of matching threads. + Output the number of matching threads. - files + files - Output the number of files associated with matching mes- - sages. This may be bigger than the number of matching mes- - sages due to duplicates (i.e. multiple files having the - same message-id). + 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. + 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. + 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> + --input=<&lt;filename>&gt; - Read input from given file, instead of from stdin. Implies - --batch. + 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-search(1),  notmuch-search-terms(7),  notmuch-show(1), notmuch-
-       tag(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)
-

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index ef05370..7a94088 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -7,8 +7,8 @@

SYNOPSIS

-       notmuch  dump  [--format=(sup|batch-tag)]  [--] [ --output=<filename> ]
-       [--] [ <search-term>...]
+       notmuch  dump  [--format=(batch-tag|sup)]  [--]  [--output=<file>] [--]
+       [<search-term> ...]

DESCRIPTION

@@ -18,62 +18,80 @@ Output is to the given filename, if any, or to stdout. These tags are the only data in the notmuch database that can't be - recreated from the messages themselves. The output of notmuch dump is + recreated from the messages themselves. The output of notmuch dump is 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). + --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. + Notmuch restore supports two plain text dump formats, both with + one message-id per line, followed by a list of tags. + + batch-tag - sup The sup dump file format is specifically chosen to be compati- - ble 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). Each line has the following - form + 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 - <message-id> ( <tag> ... ) + +<encoded-tag> +<encoded-tag> ... -- id:<quoted-mes- + sage-id> - with zero or more tags are separated by spaces. Note that (mal- - formed) message-ids may contain arbitrary non-null characters. - Note also that tags with spaces will not be correctly restored - with this format. + 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 + query, quoted using Xapian boolean term quoting rules: if + 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 + batch input format for notmuch-tag(1); note that the sin- + gle message-id query is mandatory for notmuch-restore(1). - batch-tag + sup - The 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 + 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). Each line has + the following form - +<encoded-tag> +<encoded-tag> ... -- id:<quoted-message-id> + <message-id> ( <tag> ... ) - 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 query, quoted using - Xapian boolean term quoting rules: if the ID contains whites- - pace 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 batch input format for notmuch-tag(1); note that - the single message-id query is mandatory for notmuch- - restore(1). + 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 + correctly restored with this format. - With no search terms, a dump of all messages in the database will - be generated. A "--" argument instructs notmuch that the remaining - arguments are search terms. + With no search terms, a dump of all messages in the database + will be generated. A "--" argument instructs notmuch that the + remaining arguments are search terms. - See notmuch-search-terms(7) for details of the supported syntax for - <search-terms>. + 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),  notmuch-
-       tag(1)
+       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

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 4eeaf6b..d42bfcd 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

@@ -20,30 +20,42 @@ 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. - Typically this hook is used for fetching or delivering new mail - to be imported into the database. + 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. 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. + 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.

SEE ALSO

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

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index f238e43..8a28938 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -7,14 +7,14 @@

SYNOPSIS

-       notmuch insert [options] [ +<tag>|-<tag> ... ]
+       notmuch insert [option ...] [+<tag>|-<tag> ...]

DESCRIPTION

        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.
 
@@ -29,24 +29,24 @@
        Option arguments must appear before any tag operation arguments.   Sup-
        ported options for insert include
 
-           --folder=<&lt;folder>&gt;
+           --folder=<&lt;folder>&gt;
 
-               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.
+                  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
+       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
@@ -60,4 +60,14 @@
        notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
-

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index 724cd2e..dfa370c 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch new [--no-hooks]
+       notmuch new [options]

DESCRIPTION

@@ -22,33 +22,47 @@ 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 notmuch- - config(1) for details. + 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 + The new command supports hooks. See notmuch-hooks(5) for more details on hooks. Supported options for new include --no-hooks - Prevents hooks from being run. + Prevents hooks from being run. + + --quiet + + Do not print progress or results.

SEE ALSO

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

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 2e879d7..dcfe28b 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch reply [options...] <search-term>...
+       notmuch reply [option ...] <search-term> ...

DESCRIPTION

@@ -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. @@ -34,48 +34,53 @@ 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. + default - 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. + Includes subject and quoted message body as an RFC 2822 + message. - 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. + json - headers-only - Only produces In-Reply-To, References, To, Cc, and Bcc - headers. + 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. - --format-version=N + sexp - Use the specified structured output format version. This is + 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. - --reply-to=(all|sender) + --reply-to=(all|sender) - all (default) - Replies to all addresses. + all (default) - 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: - headers in this order, and copy values from the first - that contains something other than only the user's - addresses. + Replies to all addresses. - --decrypt + 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- + 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 @@ -103,17 +108,31 @@ 
        This command supports the following special exit status codes
 
-       20     The requested format version is too old.
+       20
+
+              The requested format version is too old.
 
-       21     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), notmuch-
-       tag(1)
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not-
+       much-tag(1)
+
+ +

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 2224911..78356b1 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -8,8 +8,8 @@

SYNOPSIS

-       notmuch  restore   [--accumulate]   [--format=(auto|batch-tag|sup)]   [
-       --input=<filename> ]
+       notmuch    restore    [--accumulate]    [--format=(auto|batch-tag|sup)]
+       [--input=<filename>]

DESCRIPTION

@@ -22,47 +22,69 @@ --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. + 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). + 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 com- - patible with the format of files produced by sup-dump. So - if you've previously been using sup for mail, then the not- - much restore command provides you a way to import all of - your tags (or labels as sup calls them). + sup - batch-tag + 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). - The batch-tag dump format is intended to more robust - against malformed message-ids and tags containing whites- - pace or non-ascii(7) characters. See notmuch-dump(1) for - details on this format. + batch-tag - notmuch restore updates the maildir flags according to tag - changes if the maildir.synchronize_flags configuration - option is enabled. See notmuch-config(1) for details. + 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. - auto + 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. - 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 for- - mat contains no parentheses, should be accurate. + 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-
+       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), 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-reply(1),
+       notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not-
+       much-tag(1)
+
+ +

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 4de0916..b3afd65 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

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

DESCRIPTION

@@ -26,137 +26,158 @@ 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. + 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 + 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 number - matched and the total number), the authors of the thread - and the subject. + 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. - threads + threads - 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 - (--format=sexp). + 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 + (--format=sexp). - messages + messages - Output the message IDs 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). + 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 + 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). + 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 associ- - ated with it. All of them are included in the output, - unless limited with the --duplicate=N option. + 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 + search. - tags + 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). + 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) + --sort=(newest-first|oldest-first) - This option can be used to present results in either chronolog- - ical order (oldest-first) or reverse chronological order - (newest-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. + 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). + 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. + 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. + 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. + 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 match- - ing the search terms. + 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. + 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. + 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 number - of matching non-excluded messages in the thread, rather than - the number of matching messages. + 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 associ- - ated with each message matching the query (N is 1-based). If N - is greater than the number of files associated with the mes- - sage, don't print anything. + 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. + 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.
+       20
 
-       21     The requested format version is too new.
+              The requested format version is too old.
+
+       21
+
+              The requested format version is too new.

SEE ALSO

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

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2014, Carl Worth and many others
-

Notmuch 0.17

+

0.18

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index b323752..0123d90 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -7,96 +7,113 @@

SYNOPSIS

-       notmuch count [options...]  <search-term>...
+       notmuch count [option ...] <search-term> ...
 
-       notmuch dump [ <filename> ] [--] [ <search-term>...]
+       notmuch  dump  [--format=(batch-tag|sup)]  [--]  [--output=<file>] [--]
+       [<search-term> ...]
 
-       notmuch search [options...] <search-term>...
+       notmuch search [option ...] <search-term> ...
 
-       notmuch show [options...] <search-term>...
+       notmuch show [option ...] <search-term> ...
 
-       notmuch tag +<tag>|-<tag> [...] [--] <search-term>...
+       notmuch tag +<tag> ... -<tag> [--] <search-term> ...

DESCRIPTION

        Several notmuch commands accept a common syntax for search terms.
 
-       The  search  terms  can  consist of free-form text (and quoted phrases)
-       which  will  match  all  messages  that  contain  all  of   the   given
+       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-
        ent headers.
 
-       As a special case, a search  string  consisting  of  exactly  a  single
+       As  a  special  case,  a  search  string consisting of exactly a single
        asterisk ("*") will match all messages.
 
-       In  addition  to free text, the following prefixes can be used to force
+       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:<name-or-address>
 
-            to:<name-or-address>
+       · to:<name-or-address>
 
-            subject:<word-or-quoted-phrase>
+       · subject:<word-or-quoted-phrase>
 
-            attachment:<word>
+       · attachment:<word>
 
-            tag:<tag> (or is:<tag>)
+       · tag:<tag> (or is:<tag>)
 
-            id:<message-id>
+       · id:<message-id>
 
-            thread:<thread-id>
+       · thread:<thread-id>
 
-            folder:<directory-path>
+       · folder:<maildir-folder>
 
-            date:<since>..<until>
+       · path:<directory-path> or path:<directory-path>/**
 
-       The  from: prefix is used to match the name or address of the sender of
+       · date:<since>..<until>
+
+       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
+       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:.
 
        The attachment: prefix can be used to search for specific filenames (or
        extensions) of attachments to email messages.
 
-       For  tag:  and is: valid tag values include inbox and unread by default
-       for new messages added by notmuch new as well as any other  tag  values
+       For tag: and is: valid tag values include inbox and unread  by  default
+       for  new  messages added by notmuch new as well as any other tag values
        added manually with notmuch tag.
 
-       For  id:, message ID values are the literal contents of the Message-ID:
+       For id:, message ID values are the literal contents of the  Message-ID:
        header of email messages, but without the '<', '>' delimiters.
 
-       The thread: prefix can be used with the thread ID values that are  gen-
-       erated  internally  by  notmuch  (and do not appear in email messages).
-       These thread ID values can be seen in the first column of  output  from
+       The  thread: prefix can be used with the thread ID values that are gen-
+       erated internally by notmuch (and do not  appear  in  email  messages).
+       These  thread  ID values can be seen in the first column of output from
        notmuch search
 
-       The  folder:  prefix can be used to search for email message files that
-       are contained within particular directories within the mail  store.  If
-       the  same  email message has multiple message files associated with it,
-       it's sufficient for a match that at least one of the files is contained
-       within  a  matching  directory. Only the directory components below the
-       top-level mail database path are available to be searched.
+       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:"&quot;"&quot; 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:"&quot;"&quot;  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>
+       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>
+       <initial-timestamp>..<final-timestamp>
 
        Each timestamp is a number representing the  number  of  seconds  since
        1970-01-01 00:00:00 UTC.
@@ -121,110 +138,126 @@
        ("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.
+
- The range expression - - date:<since>..<until> - - 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 (the beginning of yesterday) and <until> - is taken as the latest time it could describe (the end of yes- - terday). Similarly, date:january..february matches from the - beginning of January to the end of February. - - 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 for clarity. - - Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's - possible to specify date:..<until> or date:<since>.. to not - limit the start or end time, respectively. Pre-1.2.1 Xapian - does not report an error on open ended ranges, but it does not - work as expected either. - - Entering date:expr without ".." (for example date:yesterday) - won't work, as it's not interpreted as a range expression at - all. You can achieve the expected result by duplicating the - expr both sides of ".." (for example date:yesterday..yester- - day). +

  The range expression

+
+       date:<since>..<until>
+
+       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
+       (the beginning of yesterday) and <until> is taken as the latest time it
+       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
+       replace the spaces with '_', or (in most cases) '-', or (in some cases)
+       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
+       or end time, respectively. Pre-1.2.1 Xapian does not report an error on
+       open ended ranges, but it does not work as expected either.
+
+       Entering date:expr without  ".."  (for  example  date:yesterday)  won't
+       work,  as  it's  not  interpreted as a range expression at all. You can
+       achieve the expected result by duplicating the expr both sides of  ".."
+       (for example date:yesterday..yesterday).
+
- Relative date and time - [N|number] (years|months|weeks|days|hours|hrs|minutes|mins|sec- - onds|secs) [...] +

  Relative date and time

+
+       [N|number]
+       onds|secs) [...]
 
-               All refer to past, can be repeated and will be accumulated.
+       All refer to past, can be repeated and will be accumulated.
 
-               Units  can  be  abbreviated  to  any length, with the otherwise
-               ambiguous single m being m for minutes and M for months.
+       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,  hun-
-               dred.  Additionally,  the  unit  may  be  preceded by "last" or
-               "this" (e.g., "last week" or "this month").
+       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 time.
+       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
+       Examples: 5M2d, two weeks
+
- Supported absolute time formats - H[H]:MM[:SS] [(am|a.m.|pm|p.m.)] +

  Supported absolute time formats

+
+       · H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
 
-               H[H] (am|a.m.|pm|p.m.)
+       · H[H] (am|a.m.|pm|p.m.)
 
-               HHMMSS
+       · HHMMSS
 
-               now
+       · now
 
-               noon
+       · noon
 
-               midnight
+       · midnight
 
-               Examples: 17:05, 5pm
+       · Examples: 17:05, 5pm
+
- Supported absolute date formats - YYYY-MM[-DD] +

  Supported absolute date formats

+
+       · YYYY-MM[-DD]
 
-               DD-MM[-[YY]YY]
+       · DD-MM[-[YY]YY]
 
-               MM-YYYY
+       · MM-YYYY
 
-               M[M]/D[D][/[YY]YY]
+       · M[M]/D[D][/[YY]YY]
 
-               M[M]/YYYY
+       · M[M]/YYYY
 
-               D[D].M[M][.[YY]YY]
+       · D[D].M[M][.[YY]YY]
 
-               D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
+       · D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
 
-               Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
+       · Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
 
-               Wee[kday]
+       · Wee[kday]
 
-               Month names can be abbreviated at three or more characters.
+       Month names can be abbreviated at three or more characters.
 
-               Weekday names can be abbreviated at three or more characters.
+       Weekday names can be abbreviated at three or more characters.
 
-               Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
+       Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
+
- Time zones - (+|-)HH:MM +

  Time zones

+
+       · (+|-)HH:MM
 
-               (+|-)HH[MM]
+       · (+|-)HH[MM]
 
-               Some time zone codes, e.g. UTC, EET.
+       Some time zone codes, e.g. UTC, EET.

SEE ALSO

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

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

diff --git a/manpages/notmuch-setup-1.mdwn b/manpages/notmuch-setup-1.mdwn index 3db4c8a..e69de29 100644 --- a/manpages/notmuch-setup-1.mdwn +++ b/manpages/notmuch-setup-1.mdwn @@ -1,149 +0,0 @@ -

NOTMUCH(1)

- -

NAME

-
-       notmuch - thread-based email index, search, and tagging
-
- -

SYNOPSIS

-
-       notmuch [option ...] command [arg ...]
-
- -

DESCRIPTION

-
-       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
-       line,  and  gives  a brief overview of the commands available. For more
-       information on e.g.  notmuch show consult the notmuch-show(1) man page,
-       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
-       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-
-       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-
-       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
-       the most widely used at this time.
-
- -

OPTIONS

-
-       Supported global options for notmuch include
-
-           --help
-
-               Print a synopsis of available commands and exit.
-
-           --version
-
-               Print the installed version of notmuch, and exit.
-
-           --config=FILE
-
-               Specify the configuration file to use. This overrides any  con-
-               figuration file specified by ${NOTMUCH_CONFIG}.
-
- -

COMMANDS

- -

  SETUP

-
-       The  notmuch  setup command is used to configure Notmuch for first use,
-       (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-
-       ration  file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
-       This configuration file will be created with descriptive comments, mak-
-       ing  it  easy to edit by hand later to change the configuration. Or you
-       can run notmuch setup again to change the configuration.
-
-       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-
-       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
-       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-
-       tax.
-
-       The search, show and  count  commands  are  used  to  query  the  email
-       database.
-
-       The  reply  command  is  useful  for  preparing a template for an email
-       reply.
-
-       The tag command is the only command available for manipulating database
-       contents.
-
-       The  dump  and restore commands can be used to create a textual dump of
-       email tags for backup purposes, and to restore from that dump.
-
-       The config command can be used to get or set settings int  the  notmuch
-       configuration file.
-
- -

ENVIRONMENT

-
-       The following environment variables can be used to control the behavior
-       of notmuch.
-
-       NOTMUCH_CONFIG
-              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.
-
- -

SEE ALSO

-
-       notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-insert(1),     notmuch-new(1),    notmuch-reply(1),    notmuch-
-       restore(1),   notmuch-search(1),   notmuch-search-terms(7),    notmuch-
-       show(1), notmuch-tag(1)
-
-       The notmuch website: http://notmuchmail.org
-
- -

CONTACT

-
-       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
-       (server: irc.freenode.net, channel: #notmuch).
-
- -

Notmuch 0.17

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 5ff0015..dc649f8 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

-       notmuch show [options...] <search-term>...
+       notmuch show [option ...] <search-term> ...

DESCRIPTION

@@ -20,152 +20,158 @@ The messages will be grouped and sorted based on the threading (all 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). + 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) - 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, (message, - header, body, attachment, and MIME part), will be delimited - by easily-parsed markers. Each marker consists of a Con- - trol-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 mul- - tipart 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 multipart - 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 - - sexp - - The output is formatted as an S-Expression (sexp). This - format is more robust than the text format for automated - processing. The nested structure of multipart MIME messages - is reflected in nested S-Expression output. By default, S- - Expression output includes all messages in a matching - thread; that is, by default, - - --format=sexp sets --entire-thread The caller can disable - this behaviour by setting --entire-thread=false - - 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 "From - " (preceded by zero or more '>' characters) have an addi- - tional '>' 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 - - raw (default for a single part, see --part) - - For a message or an attached message part, the original, - raw content of the email message is output. Consumers of - this format should expect to implement MIME decoding and - similar functions. - - For a single part (--part) the raw part content is output - after performing any necessary MIME decoding. Note that - messages with a simple body still have two parts: part 0 is - the whole message and part 1 is the body. - - For a multipart part, the part headers and body (including - all child parts) is output. - - The raw format must only be used with search terms matching - single message. + 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 + 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- + 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 + 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 + 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 + "From " (preceded by zero or more '>' characters) have an + 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 + + 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 + body of the part after performing content transfer decod- + 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 + 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. + 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 struc- - ture, and are identified in the 'json', 'sexp' or 'text' output - formats. + 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 sig- - natures found in the selected content (ie. "multipart/signed" - parts). Status of the signature will be reported (currently on- - ly supported with --format=json and --format=sexp), and the - multipart/signed part will be replaced by the signed data. + 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 content - (ie. "multipart/encrypted" parts). Status of the decryption - will be reported (currently only supported with --format=json - and --format=sexp) and on successful decryption the multi- - part/encrypted part will be replaced by the decrypted content. + 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. + Decryption expects a functioning gpg-agent(1) to provide any + needed credentials. Without one, the decryption will fail. - Implies --verify. + Implies --verify. --exclude=(true|false) - Specify whether to omit threads only matching search.tag_ex- - clude 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). + 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 re- - turned regardless (with the excluded flag being set when appro- - priate) but threads that only match in an excluded message are - not returned when --exclude=true. + 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. + 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 >&gt; 0. + 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. + 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. + 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 @@ -176,9 +182,13 @@ 
        This command supports the following special exit status codes
 
-       20     The requested format version is too old.
+       20
+
+              The requested format version is too old.
+
+       21
 
-       21     The requested format version is too new.
+              The requested format version is too new.

SEE ALSO

@@ -189,4 +199,14 @@ much-tag(1) -

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 595dc06..0537abf 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -8,9 +8,9 @@

SYNOPSIS

-       notmuch tag [options...] +<tag>|-<tag> [...] [--] <search-term> [...]
+       notmuch tag [options ...] +<tag>|-<tag> [--] <search-term> ...
 
-       notmuch tag --batch [ --input=<filename> ]
+       notmuch tag --batch [--input=<filename>]

DESCRIPTION

@@ -30,30 +30,31 @@ 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 notmuch- - config(1) for details. + 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 messages will have - no tags. + 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. + 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> + --input=<&lt;filename>&gt; - Read input from given file, instead of from stdin. Implies - --batch. + Read input from given file, instead of from stdin. Implies + --batch.

TAG FILE FORMAT

@@ -62,12 +63,12 @@ +<tag>|-<tag> [...] [--] <query> - Each line is interpreted similarly to notmuch tag command line - arguments. 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 encod- - ing, 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. + 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. + 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> @@ -88,16 +89,17 @@ 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 * - +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)""" + + +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)"""

SEE ALSO

@@ -108,4 +110,14 @@ much-show(1), -

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

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

0.18

-- 2.43.0