From: Tomi Ollila Date: Tue, 31 Dec 2013 13:22:24 +0000 (+0200) Subject: updated manpages using fingerterm on N9 X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=commitdiff_plain;h=59c3b4d66ce19a9dde85e65d5fc5c150e23de209 updated manpages using fingerterm on N9 picked instructions how to do that from commit message from Aug 2013. --- diff --git a/manpages.mdwn b/manpages.mdwn index 8c49ec4..9671c26 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -2,6 +2,7 @@ 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 diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 5359098..3db4c8a 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -91,8 +91,8 @@ 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 data- - base. + 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. @@ -146,4 +146,4 @@ (server: irc.freenode.net, channel: #notmuch). -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn new file mode 100644 index 0000000..d93f7dc --- /dev/null +++ b/manpages/notmuch-compact-1.mdwn @@ -0,0 +1,59 @@ +

NOTMUCH-COMPACT(1)

+ +

NAME

+
+       notmuch-compact - compact the notmuch database
+
+ +

SYNOPSIS

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

DESCRIPTION

+
+       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.
+
+       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>
+
+               Save the current database to the given directory before replac-
+               ing it with the compacted database. The backup  directory  must
+               not  exist and it must reside on the same mounted filesystem as
+               the current database.
+
+           --quiet
+
+               Do not report database compaction progress to stdout.
+
+ +

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.
+
+ +

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 0.17

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index bb2248a..1f7283e 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -118,4 +118,4 @@ tag(1) -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 8f7ed46..e5e7812 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -16,15 +16,15 @@ The number of matching messages (or threads) is output to stdout. - With no search terms, a count of all messages (or threads) in the data- - base will be displayed. + With no search terms, a count of all messages (or threads) in the + database 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) + --output=(messages|threads|files) messages @@ -35,31 +35,38 @@ Output the number of matching threads. + 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). + --exclude=(true|false) - Specify whether to omit messages matching search.tag_exclude + 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 + 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 + 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-
+       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 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 76eac67..ef05370 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -27,9 +27,7 @@ Notmuch restore supports two plain text dump formats, both with one message-id per line, followed by a list of tags. - sup - - The sup dump file format is specifically chosen to be compati- + 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 @@ -54,12 +52,12 @@ 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 white- - space 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 spe- - cial case of the batch input format for notmuch-tag(1); note - that the single message-id query is mandatory for notmuch- + 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 no search terms, a dump of all messages in the database will @@ -78,4 +76,4 @@ tag(1) -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 4e9f1c6..4eeaf6b 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -46,4 +46,4 @@ tag(1) -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 8ccfda1..f238e43 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -22,31 +22,31 @@ 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 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. + 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. - 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=<&lt;folder>&gt; - Deliver the message to the specified folder, relative to the - top-level directory given by the value of database.path. The + 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 + 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
@@ -60,4 +60,4 @@
        notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
-

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index 60bd880..724cd2e 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -51,4 +51,4 @@ tag(1) -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 9dde8c4..2e879d7 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -37,22 +37,23 @@ --format=(default|json|sexp|headers-only) default - Includes subject and quoted message body. + 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- - put can be used by a client to create a reply message + put can be used by a client to create a reply message intelligently. 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 + 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 + Only produces In-Reply-To, References, To, Cc, and Bcc headers. --format-version=N @@ -67,34 +68,34 @@ Replies to all addresses. 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 + 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. --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 + 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. - 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. @@ -109,10 +110,10 @@

SEE ALSO

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

+

Notmuch 0.17

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 8164f92..2224911 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -32,9 +32,7 @@ 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- + 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 @@ -43,8 +41,8 @@ batch-tag The batch-tag dump format is intended to more robust - against malformed message-ids and tags containing white- - space or non-ascii(7) characters. See notmuch-dump(1) for + against malformed message-ids and tags containing whites- + pace or non-ascii(7) characters. See notmuch-dump(1) for details on this format. notmuch restore updates the maildir flags according to tag @@ -67,4 +65,4 @@ tag(1) -

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index e8b6c27..4de0916 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -71,6 +71,10 @@ 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. + tags Output all tags that appear on any message matching the @@ -82,8 +86,8 @@ --sort=(newest-first|oldest-first) This option can be used to present results in either chronolog- - ical order (oldest-first) or reverse chronological order (new- - est-first). + ical 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- @@ -125,6 +129,17 @@ almost identical to false, but the "match count" is the number of matching non-excluded messages in the thread, rather than the number of matching messages. + + --duplicate=N + + 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. + + 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

@@ -138,10 +153,10 @@

SEE ALSO

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

+

Notmuch 0.17

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index c4fe11d..b323752 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -79,9 +79,11 @@ notmuch search The folder: prefix can be used to search for email message files that - are contained within particular directories within the mail store. Only - the directory components below the top-level mail database path are - available to be searched. + 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 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 @@ -96,59 +98,59 @@ <initial-timestamp>..<final-timestamp> - Each timestamp is a number representing the number of seconds since + Each timestamp is a number representing the number of seconds since 1970-01-01 00:00:00 UTC. - In addition to individual terms, multiple terms can be combined with - Boolean operators ( and, or, not , etc.). Each term in the query will - be implicitly connected by a logical AND if no explicit operator is - provided, (except that terms with a common prefix will be implicitly + In addition to individual terms, multiple terms can be combined with + Boolean operators ( and, or, not , etc.). Each term in the query will + be implicitly connected by a logical AND if no explicit operator is + provided, (except that terms with a common prefix will be implicitly combined with OR until we get Xapian defect #402 fixed). - Parentheses can also be used to control the combination of the Boolean - operators, but will have to be protected from interpretation by the - shell, (such as by putting quotation marks around any parenthesized + Parentheses can also be used to control the combination of the Boolean + operators, but will have to be protected from interpretation by the + shell, (such as by putting quotation marks around any parenthesized expression).

DATE AND TIME SEARCH

-       notmuch  understands a variety of standard and natural ways of express-
+       notmuch understands a variety of standard and natural ways of  express-
        ing dates and times, both in absolute terms ("2012-10-24") and in rela-
-       tive  terms ("yesterday"). Any number of relative terms can be combined
-       ("1 hour 25 minutes") and an absolute date/time can  be  combined  with
-       relative  terms  to  further adjust it. A non-exhaustive description of
+       tive terms ("yesterday"). Any number of relative terms can be  combined
+       ("1  hour  25  minutes") and an absolute date/time can be combined with
+       relative terms to further adjust it. A  non-exhaustive  description  of
        the syntax supported for absolute and relative terms is given below.
 
            The range expression
 
                date:<since>..<until>
 
-               The above expression restricts the  results  to  only  messages
+               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 "yes-
-               terday".  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  yester-
-               day). Similarly, date:january..february matches from the begin-
-               ning of January to the end of February.
+               <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
+               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
+               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
+               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-
+               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).
 
            Relative date and time
@@ -157,15 +159,15 @@
 
                All refer to past, can be repeated and will be accumulated.
 
-               Units can be abbreviated to  any  length,  with  the  otherwise
+               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
+               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").
 
-               When  combined  with  absolute date and time, the relative date
-               and time specification will  be  relative  from  the  specified
+               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
@@ -220,9 +222,9 @@
 
 
SEE ALSO

 
-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not-
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1),   notmuch-reply(1),
+       notmuch(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.16

+
Notmuch 0.17

diff --git a/manpages/notmuch-setup-1.mdwn b/manpages/notmuch-setup-1.mdwn
index 5359098..3db4c8a 100644
--- a/manpages/notmuch-setup-1.mdwn
+++ b/manpages/notmuch-setup-1.mdwn
@@ -91,8 +91,8 @@
        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  data-
-       base.
+       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.
@@ -146,4 +146,4 @@
        (server: irc.freenode.net, channel: #notmuch).
-

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 00666bd..5ff0015 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -127,39 +127,47 @@ (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. + part/encrypted part will be replaced by the decrypted content. - Decryption expects a functioning gpg-agent(1) to provide any + 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_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 + 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). - If --entire-thread is specified then complete threads are re- + 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 + priate) but threads that only match in an excluded message are not returned when --exclude=true. The default is --exclude=true. --body=(true|false) - If true (the default) notmuch show includes the bodies of the - messages in the output; if false, bodies are omitted. - --body=false is only implemented for the json and sexp formats + 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. - This is useful if the caller only needs the headers as body- + This is useful if the caller only needs the headers as body- less output is much faster and substantially smaller. - A common use of notmuch show is to display a single thread of email + --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. @@ -175,10 +183,10 @@

SEE ALSO

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

Notmuch 0.16

+

Notmuch 0.17

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 29a1a89..595dc06 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -62,21 +62,21 @@ +<tag>|-<tag> [...] [--] <query> - 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> + 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. + + In the future tag:"tag with spaces" style quoting may be supported for + <tag> as well; for this reason all double quote characters in <tag> should be hex-encoded. - The <query> should be quoted using Xapian boolean term quoting rules: - if a term contains whitespace or a close paren or starts with a double - quote, it must be enclosed in double quotes (not including any prefix) - and double quotes inside the term must be doubled (see below for exam- + The <query> should be quoted using Xapian boolean term quoting rules: + if a term contains whitespace or a close paren or starts with a double + quote, it must be enclosed in double quotes (not including any prefix) + and double quotes inside the term must be doubled (see below for exam- ples). Leading and trailing space ' ' is ignored. Empty lines and lines begin- @@ -85,8 +85,8 @@

  EXAMPLE

-       The following shows a valid input to batch tagging. Note that only  the
-       isolated  '*'  acts as a wildcard. Also note the two different quotings
+       The  following shows a valid input to batch tagging. Note that only the
+       isolated '*' acts as a wildcard. Also note the two  different  quotings
        of the tag space in tags
               +winner *
               +foo::bar%25 -- (One and Two) or (One and tag:winner)
@@ -102,10 +102,10 @@
 
 
SEE ALSO

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

 
-
Notmuch 0.16

+
Notmuch 0.17