]> git.cworth.org Git - notmuch-wiki/commitdiff
manpages, tweaked man-to-mdwm.pl a bit to make
authorTomi Ollila <tomi.ollila@iki.fi>
Tue, 6 May 2014 09:34:35 +0000 (12:34 +0300)
committerTomi Ollila <tomi.ollila@iki.fi>
Tue, 6 May 2014 09:34:35 +0000 (12:34 +0300)
this work. some post-hand-editing required...

16 files changed:
manpages.mdwn
manpages/notmuch-1.mdwn
manpages/notmuch-compact-1.mdwn
manpages/notmuch-config-1.mdwn
manpages/notmuch-count-1.mdwn
manpages/notmuch-dump-1.mdwn
manpages/notmuch-hooks-5.mdwn
manpages/notmuch-insert-1.mdwn
manpages/notmuch-new-1.mdwn
manpages/notmuch-reply-1.mdwn
manpages/notmuch-restore-1.mdwn
manpages/notmuch-search-1.mdwn
manpages/notmuch-search-terms-7.mdwn
manpages/notmuch-setup-1.mdwn
manpages/notmuch-show-1.mdwn
manpages/notmuch-tag-1.mdwn

index 9671c26de09be3fb527c96a474654eb6f451940a..f44015b40a1d6d9969731888ef564dcb8e2272eb 100644 (file)
@@ -1,18 +1,17 @@
 Manual page index
 =================
 
-* <a href='notmuch-1/'>notmuch</a>(1) - thread-based email index, search, and tagging
-* <a href='notmuch-compact-1/'>notmuch-compact</a>(1) - compact the notmuch database
-* <a href='notmuch-config-1/'>notmuch-config</a>(1) - access notmuch configuration file
-* <a href='notmuch-count-1/'>notmuch-count</a>(1) - count messages matching the given search terms
-* <a href='notmuch-dump-1/'>notmuch-dump</a>(1) - creates a plain-text dump of the tags of each message
-* <a href='notmuch-insert-1/'>notmuch-insert</a>(1) - add a message to the maildir and notmuch database
-* <a href='notmuch-new-1/'>notmuch-new</a>(1) - incorporate new mail into the notmuch database
-* <a href='notmuch-reply-1/'>notmuch-reply</a>(1) - constructs a reply template for a set of messages
-* <a href='notmuch-restore-1/'>notmuch-restore</a>(1) - restores the tags from the given file (see notmuch dump)
-* <a href='notmuch-search-1/'>notmuch-search</a>(1) - search for messages matching the given search terms
-* <a href='notmuch-setup-1/'>notmuch-setup</a>(1) - thread-based email index, search, and tagging
-* <a href='notmuch-show-1/'>notmuch-show</a>(1) - show messages matching the given search terms
-* <a href='notmuch-tag-1/'>notmuch-tag</a>(1) - add/remove tags for all messages matching the search terms
-* <a href='notmuch-hooks-5/'>notmuch-hooks</a>(5) - hooks for notmuch
-* <a href='notmuch-search-terms-7/'>notmuch-search-terms</a>(7) - syntax for notmuch queries
+* <a href='notmuch-1/'>notmuch</a>("1") - thread-based email index, search, and tagging
+* <a href='notmuch-compact-1/'>notmuch-compact</a>("1") - compact the notmuch database
+* <a href='notmuch-config-1/'>notmuch-config</a>("1") - access notmuch configuration file
+* <a href='notmuch-count-1/'>notmuch-count</a>("1") - count messages matching the given search terms
+* <a href='notmuch-dump-1/'>notmuch-dump</a>("1") - creates a plain-text dump of the tags of each message
+* <a href='notmuch-insert-1/'>notmuch-insert</a>("1") - add a message to the maildir and notmuch database
+* <a href='notmuch-new-1/'>notmuch-new</a>("1") - incorporate new mail into the notmuch database
+* <a href='notmuch-reply-1/'>notmuch-reply</a>("1") - constructs a reply template for a set of messages
+* <a href='notmuch-restore-1/'>notmuch-restore</a>("1") - restores the tags from the given file (see notmuch dump)
+* <a href='notmuch-search-1/'>notmuch-search</a>("1") - search for messages matching the given search terms
+* <a href='notmuch-show-1/'>notmuch-show</a>("1") - show messages matching the given search terms
+* <a href='notmuch-tag-1/'>notmuch-tag</a>("1") - add/remove tags for all messages matching the search terms
+* <a href='notmuch-hooks-5/'>notmuch-hooks</a>("5") - hooks for notmuch
+* <a href='notmuch-search-terms-7/'>notmuch-search-terms</a>("7") - syntax for notmuch queries
index 3db4c8ae996f670b1fcc72fec8ffa9c1a793a258..dbf4b8c97988a72abf640ada072fcac012532973 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> [<u>option</u> ...] <u>command</u> [<u>arg</u> ...]
+       <b>notmuch</b> [option ...] <b>command</b> [arg ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
 
        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.  <b>notmuch</b> <b>show</b> consult the <a href='../notmuch-show-1/'>notmuch-show</a>(1) man page,
+       information on e.g. <b>notmuch</b> <b>show</b> consult the <a href='../notmuch-show-1/'>notmuch-show</a>(1) man  page,
        also accessible via <b>notmuch</b> <b>help</b> <b>show</b>
 
        The  quickest  way  to get started with Notmuch is to simply invoke the
-       <b>notmuch</b> 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.
 </pre>
 
 <h2>NOTE</h2>
 <pre>
-       While the command-line program <b>notmuch</b> 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  <u>http://notmuchmail.org</u>  for  more about
        alternate interfaces to notmuch. The emacs-based interface  to  notmuch
        (available under <b>emacs/</b> in the Notmuch source distribution) is probably
        the most widely used at this time.
 
 <h2>OPTIONS</h2>
 <pre>
-       Supported global options for <b>notmuch</b> include
+       Supported global options for notmuch include
 
            <b>--help</b>
 
-               Print a synopsis of available commands and exit.
+                  Print a synopsis of available commands and exit.
 
            <b>--version</b>
 
-               Print the installed version of notmuch, and exit.
+                  Print the installed version of notmuch, and exit.
 
            <b>--config=FILE</b>
 
-               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}.
 </pre>
 
 <h2>COMMANDS</h2>
        rently stored, it is recommended you first convert it to maildir format
        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
 
-       Invoking  <b>notmuch</b>  with no command argument will run <b>setup</b> if the setup
+       Invoking  notmuch  with no command argument will run <b>setup</b> if the setup
        command has not previously been completed.
 </pre>
 
 <h3> &nbsp; OTHER COMMANDS</h3>
 <pre>
        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 <b>notmuch-search-terms</b>(7) for more details on the supported syn-
        tax.
 
        The <b>search</b>, <b>show</b> and  <b>count</b>  commands  are  used  to  query  the  email
        The  <b>dump</b>  and <b>restore</b> commands can be used to create a textual dump of
        email tags for backup purposes, and to restore from that dump.
 
-       The <b>config</b> command can be used to get or set settings int  the  notmuch
+       The <b>config</b> command can be used to get or set settings  in  the  notmuch
        configuration file.
 </pre>
 
        of notmuch.
 
        <b>NOTMUCH</b>_<b>CONFIG</b>
+
               Specifies the location of the notmuch configuration  file.  Not-
               much  will  use  ${HOME}/.notmuch-config if this variable is not
               set.
 
        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
+
               Location to  write  a  talloc  memory  usage  report.  See  <b>tal-</b>
               <b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
 
        <b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
+
               If  set to a non-empty value, the notmuch library will print (to
               stderr) Xapian queries it constructs.
 </pre>
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),
-       <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),     <a href='../notmuch-new-1/'>notmuch-new</a>(1),    <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),    <a href='../notmuch-restore-1/'>notmuch-</a>
-       <a href='../notmuch-restore-1/'>restore</a>(1),   <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),    <a href='../notmuch-show-1/'>notmuch-</a>
-       <a href='../notmuch-show-1/'>show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
+       <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),      <a href='../notmuch-new-1/'>notmuch-new</a>(1),      <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),     <a href='../notmuch-restore-1/'>not-</a>
+       <a href='../notmuch-restore-1/'>much-restore</a>(1),   <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>not-</a>
+       <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 
        The notmuch website: <b>http://notmuchmail.org</b>
 </pre>
 <h2>CONTACT</h2>
 <pre>
        Feel  free to send questions, comments, or kudos to the notmuch mailing
-       list &lt;notmuch@notmuchmail.org&gt; . Subscription is  not  required  before
+       list &lt;<u>notmuch@notmuchmail.org</u>&gt; . 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).
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>
index d93f7dc9a477609b230bf231684312af414c3b80..b9c846b922c419f4632347789c05021d0c942fd6 100644 (file)
@@ -7,34 +7,34 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>compact</b> [ --quiet ] [ --backup=&lt;<u>directory</u>&gt; ]
+       <b>notmuch</b> <b>compact</b> [--quiet] [--backup=&lt;<u>directory</u>&gt;]
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
-       The  <b>compact</b>  command can be used to compact the notmuch database. This
+       The  <b>compact</b> 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 <b>--backup=</b>&lt;directory&gt; option is used.
+       database  is discarded, unless the --backup=&lt;directory&gt; 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 <b>compact</b> include
 
-           <b>--backup=</b>&lt;directory&gt;
+           <b>--backup=</b>&lt<b>&</b>lt;<b>directory</b>&gt<b>&</b>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.
 
            <b>--quiet</b>
 
-               Do not report database compaction progress to stdout.
+                  Do not report database compaction progress to stdout.
 </pre>
 
 <h2>ENVIRONMENT</h2>
@@ -43,6 +43,7 @@
        of notmuch.
 
        <b>NOTMUCH</b>_<b>CONFIG</b>
+
               Specifies  the  location of the notmuch configuration file. Not-
               much will use ${HOME}/.notmuch-config if this  variable  is  not
               set.
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-count-1/'>notmuch-count</a>(1),  <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
        <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index 1f7283e7cc7dd6087b6f2006417ecb200ab14c53..3b21e389826ab2c12776f49acff274b0aae3e6d7 100644 (file)
        The  <b>config</b>  command  can be used to get or set settings in the notmuch
        configuration file.
 
-           <b>get</b> 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.
+           <b>get</b>
 
-           <b>set</b> 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.
+           <b>set</b>
+
+                  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.
 
            <b>list</b>
-               Every  configuration item is printed to stdout, each on a sepa-
-               rate line of the form:
 
-               <u>section</u>.<u>item</u>=<u>value</u>
+                  Every  configuration  item  is  printed to stdout, each on a
+                  separate line of the form:
+
+                  <u>section</u>.<u>item</u>=<u>value</u>
 
-               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.
 
            <b>database.path</b>
-               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 <b>.not-</b>
-               <b>much</b>.
+
+                  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.
 
            <b>user.name</b>
-               Your full name.
+
+                  Your full name.
 
            <b>user.primary</b>_<b>email</b>
-               Your primary email address.
+
+                  Your primary email address.
 
            <b>user.other</b>_<b>email</b>
-               A list of other email addresses at which you receive email.
+
+                  A list of other email addresses at which you receive  email.
 
            <b>new.tags</b>
-               A list of tags that will be added to all messages  incorporated
-               by <b>notmuch</b> <b>new</b>.
+
+                  A  list  of tags that will be added to all messages incorpo-
+                  rated by <b>notmuch</b> <b>new</b>.
 
            <b>new.ignore</b>
-               A list of file and directory names, without path, that will not
-               be searched for messages by <b>notmuch</b> <b>new</b>.   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 <b>notmuch</b> <b>new</b>. 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.
 
            <b>search.exclude</b>_<b>tags</b>
-               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.
 
            <b>maildir.synchronize</b>_<b>flags</b>
-               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 &apos;S&apos; flag is not present)
-
-               The  <b>notmuch</b>  <b>new</b> command will notice flag changes in filenames
-               and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b> 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 <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b> or
-               <b>notmuch</b> <b>restore</b> 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
+                  &apos;S&apos; flag is not present) T} _
+
+                  The  <b>notmuch</b>  <b>new</b>  command will notice flag changes in file-
+                  names and update tags, while the  <b>notmuch</b>  <b>tag</b>  and  <b>notmuch</b>
+                  <b>restore</b> 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 <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b>
+                  or  <b>notmuch</b>  <b>restore</b>  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.
 </pre>
 
 <h2>ENVIRONMENT</h2>
        of notmuch.
 
        <b>NOTMUCH</b>_<b>CONFIG</b>
-              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.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-count-1/'>notmuch-count</a>(1),  <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
-       <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),  <a href='../notmuch-insert-1/'>not-</a>
+       <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index e5e781272571c74476a8a6d71550fb8dff1b0486..378348d9df4ed17070baed7ce202de8f44e5571c 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>count</b> [<u>options</u>... ] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>count</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
 </pre>
 
 <h2>DESCRIPTION</h2>
 
        Supported options for <b>count</b> include
 
-           <b>--output=(messages|threads|files)</b>
+           --output=(messages|threads|files)
 
-               <b>messages</b>
+              <b>messages</b>
 
-                   Output  the  number  of  matching  messages.  This  is  the
-                   default.
+                     Output  the  number  of  matching  messages.  This is the
+                     default.
 
-               <b>threads</b>
+              <b>threads</b>
 
-                   Output the number of matching threads.
+                     Output the number of matching threads.
 
-               <b>files</b>
+              <b>files</b>
 
-                   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).
 
            <b>--exclude=(true|false)</b>
 
-               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.
 
            <b>--batch</b>
 
-               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.
 
-           <b>--input=</b>&lt;filename&gt;
+           <b>--input=</b>&lt<b>&</b>lt;<b>filename</b>&gt<b>&</b>gt;
 
-               Read input from given file,  instead  of  from  stdin.  Implies
-               <b>--batch</b>.
+                  Read  input  from given file, instead of from stdin. Implies
+                  --batch.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
-       <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),  <a href='../notmuch-insert-1/'>not-</a>
+       <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>
index ef053705a9d1e9e73c7af68e0d6f9eb8b4aa84fd..7a94088fe3d6165306101d4da990efaa5ad136db 100644 (file)
@@ -7,8 +7,8 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b>  <b>dump</b>  [<b>--format=(sup|batch-tag)</b>]  [--] [ --output=&lt;<u>filename</u>&gt; ]
-       [--] [ &lt;<u>search-term</u>&gt;...]
+       <b>notmuch</b>  <b>dump</b>  [--format=(batch-tag|sup)]  [--]  [--output=&lt;<u>file</u>&gt;] [--]
+       [&lt;<u>search-term</u>&gt; ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
        Output is to the given filename, if any, or to stdout.
 
        These tags are the only data in the  notmuch  database  that  can&apos;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.)
 
+       <b>--gzip</b>
+
+              Compress the output in a format compatible with <b>gzip</b>(1).
+
        <b>--format=(sup|batch-tag)</b>
 
-           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.
+
+              <b>batch-tag</b>
 
-           <b>sup</b>  The <b>sup</b> dump file format is specifically chosen to be compati-
-               ble  with  the  format  of  files  produced by sup-dump.  So if
-               you&apos;ve previously been using sup for  mail,  then  the  <b>notmuch</b>
-               <b>restore</b>  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 <b>batch-tag</b> dump format  is  intended  to  more
+                     robust  against malformed message-ids and tags containing
+                     whitespace or non-<b>ascii</b>(7) characters. Each line has  the
+                     form
 
-               &lt;<u>message-id</u>&gt; <b>(</b> &lt;<u>tag</u>&gt; ...  <b>)</b>
+                         +&lt;<u>encoded-tag</u>&gt;  +&lt;<u>encoded-tag</u>&gt; ... -- id:&lt;<u>quoted-mes-</u>
+                         <u>sage-id</u>&gt;
 
-               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 <b>[A-Za-z0-9@=.,</b>_<b>+-]</b> with <b>%nn</b> 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 <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note that the sin-
+                     gle message-id query is mandatory for <a href='../notmuch-restore-1/'>notmuch-restore</a>(1).
 
-           <b>batch-tag</b>
+              <b>sup</b>
 
-               The <b>batch-tag</b> dump format is intended to  more  robust  against
-               malformed  message-ids  and  tags containing whitespace or non-
-               <b>ascii</b>(7) characters.  Each line has the form
+                     The <b>sup</b> dump file format is  specifically  chosen  to  be
+                     compatible with the format of files produced by sup-dump.
+                     So if you&apos;ve previously been using sup for mail, then the
+                     <b>notmuch</b>  <b>restore</b> command provides you a way to import all
+                     of your tags (or labels as sup calls them). Each line has
+                     the following form
 
-               +&lt;<u>encoded-tag</u>&gt; +&lt;<u>encoded-tag</u>&gt; ... --  id:&lt;<u>quoted-message-id</u>&gt;
+                         &lt;<u>message-id</u>&gt; <b>(</b> &lt;<u>tag</u>&gt; ... <b>)</b>
 
-               Tags are hex-encoded by replacing every byte not  matching  the
-               regex <b>[A-Za-z0-9@=.,</b>_<b>+-]</b> with <b>%nn</b> 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 <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note that
-               the  single  message-id  query  is   mandatory   for   <a href='../notmuch-restore-1/'>notmuch-</a>
-               <a href='../notmuch-restore-1/'>restore</a>(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 &quot;--&quot; 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 &quot;--&quot; argument instructs notmuch that the
+              remaining arguments are search terms.
 
-           See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
-           &lt;search-terms&gt;.
+              See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported  syntax
+              for &lt;search-terms&gt;.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
-       <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1),  <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index 4eeaf6b10a79e6063f645694072871b9d63798da..d42bfcd94a77de5e494e91c54d4ae4f8b38275bf 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-        $DATABASEDIR/.notmuch/hooks/*
+           $DATABASEDIR/.notmuch/hooks/*
 </pre>
 
 <h2>DESCRIPTION</h2>
        The currently available hooks are described below.
 
            <b>pre-new</b>
-               This hook is invoked by the  <b>new</b>  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 <b>new</b> command.
 
-               Typically this hook is used for fetching or delivering new mail
-               to be imported into the database.
+                  This hook is invoked by the <b>new</b> 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 <b>new</b> command.
+
+                  Typically  this  hook is used for fetching or delivering new
+                  mail to be imported into the database.
 
            <b>post-new</b>
-               This hook is invoked by the <b>new</b> 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 <b>new</b> 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.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-insert-1/'>not-</a>
        <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1),  <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index f238e433d75891bacb6230554e85f505ce477f25..8a28938147c95241993f134e7d6b87db2fb5ee71 100644 (file)
@@ -7,14 +7,14 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>insert</b> [<u>options</u>] [ +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; ... ]
+       <b>notmuch</b> <b>insert</b> [option ...] [+&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
        <b>notmuch</b> <b>insert</b> reads a message from standard input and delivers it into
        the maildir directory given by configuration option <b>database.path</b>, 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  <b>not-</b>
        <b>much</b> <b>new</b> afterwards.
 
        Option arguments must appear before any tag operation arguments.   Sup-
        ported options for <b>insert</b> include
 
-           <b>--folder=</b>&lt<b>&</b>lt;<u>folder</u>&gt<b>&</b>gt;
+           <b>--folder=</b>&lt<b>&</b>lt;<b>folder</b>&gt<b>&</b>gt;
 
-               Deliver  the  message  to the specified folder, relative to the
-               top-level directory given by the value of  <b>database.path</b>.   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 <b>database.path</b>. The
+                  default is to deliver to the top-level directory.
 
            <b>--create-folder</b>
 
-               Try  to  create  the folder named by the <b>--folder</b> 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.
 </pre>
 
 <h2>EXIT STATUS</h2>
 <pre>
        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
        <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>
index 724cd2ef16aa1b540f261f801305e3ea80248c29..dfa370cd855d9e8ac6dc4d7e0ce88de203ac66b5 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>new</b> [<b>--no-hooks</b>]
+       <b>notmuch</b> <b>new</b> [options]
 </pre>
 
 <h2>DESCRIPTION</h2>
        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 <b>notmuch</b> <b>new</b> 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 <b>notmuch</b> with no command argument will run <b>new</b> if <b>notmuch</b> <b>setup</b>
+       Invoking notmuch with no command argument will run <b>new</b> if <b>notmuch</b> <b>setup</b>
        has  previously been completed, but <b>notmuch</b> <b>new</b> has not previously been
        run.
 
        <b>notmuch</b> <b>new</b> updates tags according  to  maildir  flag  changes  if  the
-       <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <a href='../notmuch-config-1/'>notmuch-</a>
-       <a href='../notmuch-config-1/'>config</a>(1) for details.
+       <b>maildir.synchronize</b>_<b>flags</b>  configuration  option  is  enabled. See <a href='../notmuch-config-1/'>not-</a>
+       <a href='../notmuch-config-1/'>much-config</a>(1) for details.
 
-       The <b>new</b> command supports hooks. See  <b>notmuch-hooks(5)</b> for more  details
+       The <b>new</b> command supports hooks. See <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5) for  more  details
        on hooks.
 
        Supported options for <b>new</b> include
 
            <b>--no-hooks</b>
 
-               Prevents hooks from being run.
+                  Prevents hooks from being run.
+
+           <b>--quiet</b>
+
+                  Do not print progress or results.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index 2e879d7aea2f480179c5c1b961922d1522fd4872..dcfe28ba4c634f38eb5daf4e296bd570af5d33de 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>reply</b> [<u>options</u>...] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>reply</b> [option ...] &lt;<u>search-term</u>&gt; ...
 </pre>
 
 <h2>DESCRIPTION</h2>
@@ -17,7 +17,7 @@
        To  make  replying to email easier, <b>notmuch</b> <b>reply</b> 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
-       <b>--reply-to=sender</b> 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&apos;s email addresses (as
        configured in primary_mail or other_email in the .notmuch-config  file)
        in the recipient list.
 
        Supported options for <b>reply</b> include
 
-              <b>--format=</b>(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
+           --format=(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
 
-                  <b>default</b>
-                      Includes  subject and quoted message body as an RFC 2822
-                      message.
+              <b>default</b>
 
-                  <b>json</b>
-                      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.
 
-                  <b>sexp</b>
-                      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.
+              <b>json</b>
 
-                  <b>headers-only</b>
-                      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.
 
-              <b>--format-version=N</b>
+              <b>sexp</b>
 
-                  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.
+
+              <b>headers-only</b>
+
+                     Only produces In-Reply-To, References, To,  Cc,  and  Bcc
+                     headers.
+
+           <b>--format-version=N</b>
+
+                  Use  the specified structured output format version. This is
                   intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally.  If
                   omitted, the latest supported version will be used.
 
-              <b>--reply-to=</b>(<b>all</b>|<b>sender</b>)
+           --reply-to=(<b>all</b>|<b>sender</b>)
 
-                  <b>all</b> (default)
-                      Replies to all addresses.
+              <b>all</b> <b>(default)</b>
 
-                  <b>sender</b>
-                      Replies  only  to  the sender. If replying to user&apos;s own
-                      message (Reply-to: or From: header is one of the  user&apos;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&apos;s
-                      addresses.
+                     Replies to all addresses.
 
-              <b>--decrypt</b>
+              <b>sender</b>
+
+                     Replies  only  to  the  sender. If replying to user&apos;s own
+                     message (Reply-to: or From: header is one of  the  user&apos;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&apos;s addresses.
+
+           <b>--decrypt</b>
 
                   Decrypt any MIME encrypted parts found in the selected  con-
                   tent   (ie.  &quot;multipart/encrypted&quot;  parts).  Status  of  the
 <pre>
        This command supports the following special exit status codes
 
-       <b>20</b>     The requested format version is too old.
+       <b>20</b>
+
+              The requested format version is too old.
 
-       <b>21</b>     The requested format version is too new.
+       <b>21</b>
+
+              The requested format version is too new.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index 2224911865f0ef6330e92f5d44840202a5a6002b..78356b11f24d562525f26d268505531192c391cf 100644 (file)
@@ -8,8 +8,8 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b>  <b>restore</b>   [<b>--accumulate</b>]   [<b>--format=(auto|batch-tag|sup)</b>]   [
-       --input=&lt;<u>filename</u>&gt; ]
+       <b>notmuch</b>    <b>restore</b>    [--accumulate]    [--format=(auto|batch-tag|sup)]
+       [--input=&lt;<u>filename</u>&gt;]
 </pre>
 
 <h2>DESCRIPTION</h2>
 
            <b>--accumulate</b>
 
-               The  union  of the existing and new tags is applied, instead of
-               replacing each message&apos;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&apos;s tags as they are  read  in  from
+                  the dump file.
 
            <b>--format=(sup|batch-tag|auto)</b>
 
-               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 <a href='../notmuch-dump-1/'>notmuch-dump</a>(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 <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
 
-               <b>sup</b>  The <b>sup</b> dump file format is specifically chosen to be com-
-                   patible with the format of files produced by sup-dump.   So
-                   if you&apos;ve previously been using sup for mail, then the <b>not-</b>
-                   <b>much</b> <b>restore</b> command provides you a way to  import  all  of
-                   your tags (or labels as sup calls them).
+                  <b>sup</b>
 
-               <b>batch-tag</b>
+                         The <b>sup</b> dump file format is specifically chosen to be
+                         compatible with  the  format  of  files  produced  by
+                         sup-dump.  So if you&apos;ve previously been using sup for
+                         mail, then the <b>notmuch</b> <b>restore</b> command provides you a
+                         way  to  import  all  of  your tags (or labels as sup
+                         calls them).
 
-                   The  <b>batch-tag</b>  dump  format  is  intended  to  more robust
-                   against malformed message-ids and tags  containing  whites-
-                   pace  or  non-<b>ascii</b>(7) characters.  See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
-                   details on this format.
+                  <b>batch-tag</b>
 
-                   <b>notmuch</b> <b>restore</b> updates the maildir flags according to  tag
-                   changes   if  the  <b>maildir.synchronize</b>_<b>flags</b>  configuration
-                   option is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for details.
+                         The <b>batch-tag</b> dump format is intended to more  robust
+                         against  malformed  message-ids  and  tags containing
+                         whitespace  or  non-<b>ascii</b>(7)  characters.  See   <a href='../notmuch-dump-1/'>not-</a>
+                         <a href='../notmuch-dump-1/'>much-dump</a>(1) for details on this format.
 
-               <b>auto</b>
+                         <b>notmuch</b>  <b>restore</b>  updates the maildir flags according
+                         to tag changes if the <b>maildir.synchronize</b>_<b>flags</b>  con-
+                         figuration  option  is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(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.
+                  <b>auto</b>
+
+                         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.
+</pre>
+
+<h2>GZIPPED INPUT</h2>
+<pre>
+       <b>notmuch</b> <b>restore</b> will detect if the input is compressed in <b>gzip</b>(1)  for-
+       mat  and automatically decompress it while reading. This detection does
+       not depend on file naming and in particular works for standard input.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
-       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),   <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
-       <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not-</a>
+       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),   <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+       <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index 4de091628229f4de616372191bcf0c6465b8e21e..b3afd65360ab5571478023a7ad0b3da79e6b49f7 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>search</b> [<u>options</u>...] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>search</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
 </pre>
 
 <h2>DESCRIPTION</h2>
 
        Supported options for <b>search</b> include
 
-           <b>--format=</b>(<b>json</b>|<b>sexp</b>|<b>text</b>|<b>text0</b>)
+           <b>--format=(json|sexp|text|text0)</b>
 
-               Presents  the  results  in  either JSON, S-Expressions, newline
-               character separated plain-text  (default),  or  null  character
-               separated  plain-text (compatible with <b>xargs</b>(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  <b>xargs</b>(1) -0 option
+                  where available).
 
            <b>--format-version=N</b>
 
-               Use the specified structured output format  version.   This  is
-               intended  for  programs  that invoke <a href='../notmuch-1/'>notmuch</a>(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 <a href='../notmuch-1/'>notmuch</a>(1) internally. If
+                  omitted, the latest supported version will be used.
 
-           <b>--output=(summary|threads|messages|files|tags)</b>
+           --output=(summary|threads|messages|files|tags)
 
-               <b>summary</b>
+              <b>summary</b>
 
-                   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.
 
-               <b>threads</b>
+              <b>threads</b>
 
-                   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).
 
-               <b>messages</b>
+              <b>messages</b>
 
-                   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).
 
-               <b>files</b>
+              <b>files</b>
 
-                   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 <b>folder:</b> or  <b>path:</b>  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.
 
-               <b>tags</b>
+              <b>tags</b>
 
-                   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).
 
-           <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
+           <b>--sort=(newest-first|oldest-first)</b>
 
-               This option can be used to present results in either chronolog-
-               ical   order  (<b>oldest-first</b>)  or  reverse  chronological  order
-               (<b>newest-first</b>).
+                  This option can be used to present results in either chrono-
+                  logical  order (<b>oldest-first</b>) or reverse chronological order
+                  (<b>newest-first</b>).
 
-               Note: The thread order  will  be  distinct  between  these  two
-               options  (beyond  being  simply reversed). When sorting by <b>old-</b>
-               <b>est-first</b> the threads will be sorted by the oldest  message  in
-               each  thread, but when sorting by <b>newest-first</b> 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 <b>old-</b>
+                  <b>est-first</b> the threads will be sorted by the  oldest  message
+                  in each thread, but when sorting by <b>newest-first</b> 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).
 
            <b>--offset=[-]N</b>
 
-               Skip  displaying  the  first  N  results. With the leading &apos;-&apos;,
-               start at the Nth result from the end.
+                  Skip displaying the first N results. With the  leading  &apos;-&apos;,
+                  start at the Nth result from the end.
 
            <b>--limit=N</b>
 
-               Limit the number of displayed results to N.
+                  Limit the number of displayed results to N.
 
            <b>--exclude=(true|false|all|flag)</b>
 
-               A message is called &quot;excluded&quot; 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 &quot;excluded&quot; 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, <b>true</b>, prevents excluded messages from match-
-               ing the search terms.
+                  The default value, <b>true</b>,  prevents  excluded  messages  from
+                  matching the search terms.
 
-               <b>all</b> additionally prevents excluded messages from  appearing  in
-               displayed  results,  in  effect behaving as though the excluded
-               messages do not exist.
+                  <b>all</b>  additionally  prevents excluded messages from appearing
+                  in displayed results,  in  effect  behaving  as  though  the
+                  excluded messages do not exist.
 
-               <b>false</b> allows excluded messages to match search terms and appear
-               in displayed results. Excluded messages are still marked in the
-               relevant outputs.
+                  <b>false</b>  allows  excluded  messages  to match search terms and
+                  appear in displayed results.  Excluded  messages  are  still
+                  marked in the relevant outputs.
 
-               <b>flag</b> only has an effect when <b>--output=summary</b>.  The  output  is
-               almost  identical to <b>false</b>, but the &quot;match count&quot; is the number
-               of matching non-excluded messages in the  thread,  rather  than
-               the number of matching messages.
+                  <b>flag</b> only has an effect when --output=summary. The output is
+                  almost identical to <b>false</b>, but the &quot;match count&quot; is the num-
+                  ber  of matching non-excluded messages in the thread, rather
+                  than the number of matching messages.
 
            <b>--duplicate=N</b>
 
-               Effective  with <b>--output=files</b>, 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&apos;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&apos;t print anything.
 
-               Note that this option is orthogonal  with  the  <b>folder:</b>  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 <b>folder:</b> search
+                  prefix. The prefix matches messages based on filenames. This
+                  option filters filenames of the matching messages.
 </pre>
 
 <h2>EXIT STATUS</h2>
 <pre>
        This command supports the following special exit status codes
 
-       <b>20</b>     The requested format version is too old.
+       <b>20</b>
 
-       <b>21</b>     The requested format version is too new.
+              The requested format version is too old.
+
+       <b>21</b>
+
+              The requested format version is too new.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not-</a>
-       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),   <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
-       <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1),  <a href='../notmuch-tag-1/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),   <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+       <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),  <a href='../notmuch-tag-1/'>not-</a>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
index b3237524931968bdfdf2151c3526867b9563ffdf..0123d9054c6d248cdf353c24a7ccb46047e31bab 100644 (file)
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>count</b> [<u>options...</u>]  &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>count</b> [option ...] &lt;<u>search-term</u>&gt; ...
 
-       <b>notmuch</b> <b>dump</b> [ &lt;<u>filename</u>&gt; ] [--] [ &lt;<u>search-term</u>&gt;...]
+       <b>notmuch</b>  <b>dump</b>  [--format=(batch-tag|sup)]  [--]  [--output=&lt;<u>file</u>&gt;] [--]
+       [&lt;<u>search-term</u>&gt; ...]
 
-       <b>notmuch</b> <b>search</b> [<u>options</u>...] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>search</b> [option ...] &lt;<u>search-term</u>&gt; ...
 
-       <b>notmuch</b> <b>show</b> [<u>options</u>...] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>show</b> [option ...] &lt;<u>search-term</u>&gt; ...
 
-       <b>notmuch</b> <b>tag</b> +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>tag</b> +&lt;<u>tag</u>&gt; ... -&lt;<u>tag</u>&gt; [--] &lt;<u>search-term</u>&gt; ...
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
        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 (&quot;*&quot;) 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 &lt;brackets&gt;
        indicate user-supplied values):
 
-            from:&lt;name-or-address&gt;
+       Â· from:&lt;name-or-address&gt;
 
-            to:&lt;name-or-address&gt;
+       Â· to:&lt;name-or-address&gt;
 
-            subject:&lt;word-or-quoted-phrase&gt;
+       Â· subject:&lt;word-or-quoted-phrase&gt;
 
-            attachment:&lt;word&gt;
+       Â· attachment:&lt;word&gt;
 
-            tag:&lt;tag&gt; (or is:&lt;tag&gt;)
+       Â· tag:&lt;tag&gt; (or is:&lt;tag&gt;)
 
-            id:&lt;message-id&gt;
+       Â· id:&lt;message-id&gt;
 
-            thread:&lt;thread-id&gt;
+       Â· thread:&lt;thread-id&gt;
 
-            folder:&lt;directory-path&gt;
+       Â· folder:&lt;maildir-folder&gt;
 
-            date:&lt;since&gt;..&lt;until&gt;
+       Â· path:&lt;directory-path&gt; or path:&lt;directory-path&gt;/**
 
-       The  <b>from:</b> prefix is used to match the name or address of the sender of
+       Â· date:&lt;since&gt;..&lt;until&gt;
+
+       The <b>from:</b> prefix is used to match the name or address of the sender  of
        an email message.
 
        The <b>to:</b> 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 <b>subject:</b> will match only text from the subject
-       of an email. Searching for a phrase in  the  subject  is  supported  by
+       Any term prefixed with <b>subject:</b> 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 <b>sub-</b>
        <b>ject:</b>.
 
        The <b>attachment:</b> prefix can be used to search for specific filenames (or
        extensions) of attachments to email messages.
 
-       For  <b>tag:</b>  and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by default
-       for new messages added by <b>notmuch</b> <b>new</b> as well as any other  tag  values
+       For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b>  by  default
+       for  new  messages added by <b>notmuch</b> <b>new</b> as well as any other tag values
        added manually with <b>notmuch</b> <b>tag</b>.
 
-       For  <b>id:</b>, message ID values are the literal contents of the Message-ID:
+       For <b>id:</b>, message ID values are the literal contents of the  Message-ID:
        header of email messages, but without the &apos;&lt;&apos;, &apos;&gt;&apos; delimiters.
 
-       The <b>thread:</b> 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  <b>thread:</b> 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
        <b>notmuch</b> <b>search</b>
 
-       The  <b>folder:</b>  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&apos;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 <b>path:</b> 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,  <b>path:</b>  matches  messages in the specified directory only. The
+       &quot;/**&quot; suffix can be used to match messages in the  specified  directory
+       and  all  its  subdirectories recursively.  <b>path:</b>&quot<b>&</b>quot;&quot<b>&</b>quot; matches messages in
+       the root of the mail store and, likewise, <b>path:**</b> matches all messages.
+
+       The <b>folder:</b> prefix searches for email messages by maildir or MH folder.
+       For MH-style folders, this is equivalent to <b>path:</b>.  For  maildir,  this
+       includes messages in the &quot;new&quot; and &quot;cur&quot; subdirectories. The exact syn-
+       tax for  maildir  folders  depends  on  your  mail  configuration.  For
+       maildir++,  <b>folder:</b>&quot<b>&</b>quot;&quot<b>&</b>quot;  matches  the  inbox folder (which is the root in
+       maildir++), other folder names always start with &quot;.&quot;, and nested  fold-
+       ers  are separated by &quot;.&quot;s, such as <b>folder:.classes.topology</b>. For &quot;file
+       system&quot; maildir, the inbox is typically <b>folder:INBOX</b> and nested folders
+       are separated by slashes, such as <b>folder:classes/topology</b>.
+
+       Both  <b>path:</b> and <b>folder:</b> will find a message if <u>any</u> copy of that message
+       is in the specific directory/folder.
 
        The <b>date:</b> 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:&lt;since&gt;..&lt;until&gt;
+       date:&lt;since&gt;..&lt;until&gt;
 
        See <b>DATE</b> <b>AND</b> <b>TIME</b> <b>SEARCH</b> below for details on the range expression, and
        supported syntax for &lt;since&gt; and &lt;until&gt; date and time expressions.
 
        The time range can also be specified using timestamps with a syntax of:
 
-            &lt;initial-timestamp&gt;..&lt;final-timestamp&gt;
+       &lt;initial-timestamp&gt;..&lt;final-timestamp&gt;
 
        Each timestamp is a number representing the  number  of  seconds  since
        1970-01-01 00:00:00 UTC.
        (&quot;1  hour  25  minutes&quot;) 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.
+</pre>
 
-           <b>The</b> <b>range</b> <b>expression</b>
-
-               date:&lt;since&gt;..&lt;until&gt;
-
-               The  above  expression  restricts  the results to only messages
-               from &lt;since&gt; to &lt;until&gt;, based on the Date: header.
-
-               &lt;since&gt; and &lt;until&gt;  can  describe  imprecise  times,  such  as
-               &quot;yesterday&quot;.   In  this  case, &lt;since&gt; is taken as the earliest
-               time it could describe (the beginning of yesterday) and &lt;until&gt;
-               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 &apos;_&apos;, or (in most cases) &apos;-&apos;, 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&apos;s
-               possible  to  specify  date:..&lt;until&gt;  or date:&lt;since&gt;.. 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 &quot;..&quot;  (for  example  date:yesterday)
-               won&apos;t  work,  as  it&apos;s not interpreted as a range expression at
-               all. You can achieve the expected  result  by  duplicating  the
-               expr  both  sides of &quot;..&quot;  (for example date:yesterday..yester-
-               day).
+<h3> &nbsp; The range expression</h3>
+<pre>
+       date:&lt;since&gt;..&lt;until&gt;
+
+       The  above  expression  restricts  the  results  to  only messages from
+       &lt;since&gt; to &lt;until&gt;, based on the Date: header.
+
+       &lt;since&gt; and &lt;until&gt; can describe imprecise times, such as  &quot;yesterday&quot;.
+       In  this  case, &lt;since&gt; is taken as the earliest time it could describe
+       (the beginning of yesterday) and &lt;until&gt; 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 &apos;_&apos;, or (in most cases) &apos;-&apos;, 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&apos;s possi-
+       ble to specify date:..&lt;until&gt; or date:&lt;since&gt;.. 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  &quot;..&quot;  (for  example  date:yesterday)  won&apos;t
+       work,  as  it&apos;s  not  interpreted as a range expression at all. You can
+       achieve the expected result by duplicating the expr both sides of  &quot;..&quot;
+       (for example date:yesterday..yesterday).
+</pre>
 
-           <b>Relative</b> <b>date</b> <b>and</b> <b>time</b>
-               [N|number] (years|months|weeks|days|hours|hrs|minutes|mins|sec-
-               onds|secs) [...]
+<h3> &nbsp; Relative date and time</h3>
+<pre>
+       [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 &quot;last&quot; or
-               &quot;this&quot; (e.g., &quot;last week&quot; or &quot;this month&quot;).
+       Number  can  also  be  written  out one, two, ..., ten, dozen, hundred.
+       Additionally, the unit may be preceded by &quot;last&quot; or &quot;this&quot; (e.g., &quot;last
+       week&quot; or &quot;this month&quot;).
 
-               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
+</pre>
 
-           <b>Supported</b> <b>absolute</b> <b>time</b> <b>formats</b>
-               H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
+<h3> &nbsp; Supported absolute time formats</h3>
+<pre>
+       Â· 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
+</pre>
 
-           <b>Supported</b> <b>absolute</b> <b>date</b> <b>formats</b>
-               YYYY-MM[-DD]
+<h3> &nbsp; Supported absolute date formats</h3>
+<pre>
+       Â· 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
+</pre>
 
-           <b>Time</b> <b>zones</b>
-               (+|-)HH:MM
+<h3> &nbsp; Time zones</h3>
+<pre>
+       Â· (+|-)HH:MM
 
-               (+|-)HH[MM]
+       Â· (+|-)HH[MM]
 
-               Some time zone codes, e.g. UTC, EET.
+       Some time zone codes, e.g. UTC, EET.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not-</a>
-       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),   <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),   <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
        <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>
index 3db4c8ae996f670b1fcc72fec8ffa9c1a793a258..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 100644 (file)
@@ -1,149 +0,0 @@
-<h1>NOTMUCH(1)</h1>
-
-<h2>NAME</h2>
-<pre>
-       notmuch - thread-based email index, search, and tagging
-</pre>
-
-<h2>SYNOPSIS</h2>
-<pre>
-       <b>notmuch</b> [<u>option</u> ...] <u>command</u> [<u>arg</u> ...]
-</pre>
-
-<h2>DESCRIPTION</h2>
-<pre>
-       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.  <b>notmuch</b> <b>show</b> consult the <a href='../notmuch-show-1/'>notmuch-show</a>(1) man page,
-       also accessible via <b>notmuch</b> <b>help</b> <b>show</b>
-
-       The  quickest  way  to get started with Notmuch is to simply invoke the
-       <b>notmuch</b> command with no arguments, which will interactively  guide  you
-       through the process of indexing your mail.
-</pre>
-
-<h2>NOTE</h2>
-<pre>
-       While the command-line program <b>notmuch</b> 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 <b>emacs/</b> in the Notmuch source distribution) is probably
-       the most widely used at this time.
-</pre>
-
-<h2>OPTIONS</h2>
-<pre>
-       Supported global options for <b>notmuch</b> include
-
-           <b>--help</b>
-
-               Print a synopsis of available commands and exit.
-
-           <b>--version</b>
-
-               Print the installed version of notmuch, and exit.
-
-           <b>--config=FILE</b>
-
-               Specify the configuration file to use. This overrides any  con-
-               figuration file specified by ${NOTMUCH_CONFIG}.
-</pre>
-
-<h2>COMMANDS</h2>
-
-<h3> &nbsp; SETUP</h3>
-<pre>
-       The  <b>notmuch</b>  <b>setup</b> 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 <b>notmuch</b> <b>setup</b> 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&apos;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 <b>notmuch</b> <b>setup</b> <b>.</b>
-
-       Invoking  <b>notmuch</b>  with no command argument will run <b>setup</b> if the setup
-       command has not previously been completed.
-</pre>
-
-<h3> &nbsp; OTHER COMMANDS</h3>
-<pre>
-       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 <b>search</b>, <b>show</b> and  <b>count</b>  commands  are  used  to  query  the  email
-       database.
-
-       The  <b>reply</b>  command  is  useful  for  preparing a template for an email
-       reply.
-
-       The <b>tag</b> command is the only command available for manipulating database
-       contents.
-
-       The  <b>dump</b>  and <b>restore</b> commands can be used to create a textual dump of
-       email tags for backup purposes, and to restore from that dump.
-
-       The <b>config</b> command can be used to get or set settings int  the  notmuch
-       configuration file.
-</pre>
-
-<h2>ENVIRONMENT</h2>
-<pre>
-       The following environment variables can be used to control the behavior
-       of notmuch.
-
-       <b>NOTMUCH</b>_<b>CONFIG</b>
-              Specifies the location of the notmuch configuration  file.  Not-
-              much  will  use  ${HOME}/.notmuch-config if this variable is not
-              set.
-
-       <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
-              Location to  write  a  talloc  memory  usage  report.  See  <b>tal-</b>
-              <b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
-
-       <b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
-              If  set to a non-empty value, the notmuch library will print (to
-              stderr) Xapian queries it constructs.
-</pre>
-
-<h2>SEE ALSO</h2>
-<pre>
-       <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),
-       <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),     <a href='../notmuch-new-1/'>notmuch-new</a>(1),    <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),    <a href='../notmuch-restore-1/'>notmuch-</a>
-       <a href='../notmuch-restore-1/'>restore</a>(1),   <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),    <a href='../notmuch-show-1/'>notmuch-</a>
-       <a href='../notmuch-show-1/'>show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
-
-       The notmuch website: <b>http://notmuchmail.org</b>
-</pre>
-
-<h2>CONTACT</h2>
-<pre>
-       Feel  free to send questions, comments, or kudos to the notmuch mailing
-       list &lt;notmuch@notmuchmail.org&gt; . 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).
-</pre>
-
-<h2>Notmuch 0.17</h2>
index 5ff001593deac011cd472659f18df631174957b5..dc649f8a54ffe5e43b4a013893d7ee3960c9a118 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>show</b> [<u>options</u>...] &lt;<u>search-term</u>&gt;...
+       <b>notmuch</b> <b>show</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
 </pre>
 
 <h2>DESCRIPTION</h2>
        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 <b>show</b> include
 
            <b>--entire-thread=(true|false)</b>
 
-               If true, <b>notmuch</b> <b>show</b> outputs all messages in the thread of any
-               message  matching  the  search terms; if false, it outputs only
-               the matching messages. For <b>--format=json</b> and <b>--format=sexp</b> this
-               defaults to true.  For other formats, this defaults to false.
-
-           <b>--format=(text|json|sexp|mbox|raw)</b>
-
-               <b>text</b> (default for messages)
-
-                   The  default  plain-text  format  has all text-content MIME
-                   parts decoded. Various components in the output,  (<b>message</b>,
-                   <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), 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,  (&apos;{&apos;
-                   or  &apos;}&apos;), to either open or close the component. For a mul-
-                   tipart MIME message, these parts will be nested.
-
-               <b>json</b>
-
-                   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,
-
-                   <b>--format=json</b>  sets  <b>--entire-thread</b> The caller can disable
-                   this behaviour by setting <b>--entire-thread=false</b>
-
-               <b>sexp</b>
-
-                   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,
-
-                   <b>--format=sexp</b>  sets  <b>--entire-thread</b> The caller can disable
-                   this behaviour by setting <b>--entire-thread=false</b>
-
-               <b>mbox</b>
-
-                   All matching messages are output in the  traditional,  Unix
-                   mbox  format  with  each  message  being prefixed by a line
-                   beginning with &quot;From &quot; and a  blank  line  separating  each
-                   message.  Lines in the message content beginning with &quot;From
-                   &quot; (preceded by zero or more &apos;&gt;&apos; characters) have  an  addi-
-                   tional  &apos;&gt;&apos;  character  added.  This reversible escaping is
-                   termed &quot;mboxrd&quot; format and described in detail here:
-
-                   http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
-
-               <b>raw</b> (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, <b>notmuch</b> <b>show</b> 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)
+
+              <b>text</b> <b>(default</b> <b>for</b> <b>messages)</b>
+
+                     The default plain-text format has all  text-content  MIME
+                     parts  decoded.  Various  components in the output, (<b>mes-</b>
+                     <b>sage</b>, <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>),  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,
+                     (&apos;{&apos; or &apos;}&apos;), to either open or close the component.  For
+                     a multipart MIME message, these parts will be nested.
+
+              <b>json</b>
+
+                     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.
+
+              <b>sexp</b>
+
+                     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.
+
+              <b>mbox</b>
+
+                     All matching messages are output in the traditional, Unix
+                     mbox format with each message being prefixed  by  a  line
+                     beginning  with  &quot;From &quot; and a blank line separating each
+                     message. Lines in  the  message  content  beginning  with
+                     &quot;From &quot; (preceded by zero or more &apos;&gt;&apos; characters) have an
+                     additional &apos;&gt;&apos; character added. This reversible  escaping
+                     is termed &quot;mboxrd&quot; format and described in detail here:
+
+                     <u>http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html</u>
+
+              <b>raw</b> <b>(default</b> <b>if</b> <b>--part</b> <b>is</b> <b>given)</b>
+
+                     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.
 
            <b>--format-version=N</b>
 
-               Use the specified structured output format  version.   This  is
-               intended  for  programs  that invoke <a href='../notmuch-1/'>notmuch</a>(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 <a href='../notmuch-1/'>notmuch</a>(1) internally. If
+                  omitted, the latest supported version will be used.
 
            <b>--part=N</b>
 
-               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 &apos;json&apos;, &apos;sexp&apos; or &apos;text&apos; 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  &apos;json&apos;, &apos;sexp&apos; or
+                  &apos;text&apos; 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.
 
            <b>--verify</b>
 
-               Compute and report the validity of any MIME cryptographic  sig-
-               natures  found  in the selected content (ie. &quot;multipart/signed&quot;
-               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.  &quot;multi-
+                  part/signed&quot;  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.
 
            <b>--decrypt</b>
 
-               Decrypt any MIME encrypted parts found in the selected  content
-               (ie.  &quot;multipart/encrypted&quot;  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.  &quot;multipart/encrypted&quot;  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 <b>gpg-agent</b>(1) to provide any
-               needed credentials. Without one, the decryption will fail.
+                  Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
+                  needed credentials. Without one, the decryption will fail.
 
-               Implies --verify.
+                  Implies --verify.
 
            <b>--exclude=(true|false)</b>
 
-               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 <b>--exclude=true.</b>
+                  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 <b>--exclude=true.</b>
+                  The default is --exclude=true.
 
            <b>--body=(true|false)</b>
 
-               If  true  (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
-               messages  in  the  output;  if  false,  bodies   are   omitted.
-               <b>--body=false</b>  is only implemented for the json and sexp formats
-               and it is incompatible with <b>--part</b> &gt<b>&</b>gt; <b>0.</b>
+                  If true (the default) <b>notmuch</b> <b>show</b> 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 &gt; 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.
 
            <b>--include-html</b>
 
-               Include &quot;text/html&quot; parts as part of the output (currently only
-               supported with --format=json and --format=sexp).   By  default,
-               unless <b>--part=N</b> is used to select a specific part or <b>--include-</b>
-               <b>html</b> is used to include all &quot;text/html&quot;  parts,  no  part  with
-               content type &quot;text/html&quot; is included in the output.
+                  Include &quot;text/html&quot; 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 &quot;text/html&quot; parts,
+                  no part with content type &quot;text/html&quot;  is  included  in  the
+                  output.
 
        A  common  use  of  <b>notmuch</b> <b>show</b> is to display a single thread of email
        messages. For this, use a search term of &quot;thread:&lt;thread-id&gt;&quot; as can be
 <pre>
        This command supports the following special exit status codes
 
-       <b>20</b>     The requested format version is too old.
+       <b>20</b>
+
+              The requested format version is too old.
+
+       <b>21</b>
 
-       <b>21</b>     The requested format version is too new.
+              The requested format version is too new.
 </pre>
 
 <h2>SEE ALSO</h2>
        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>
index 595dc06939da1e1d5b4b94ddfd87a621c98a3232..0537abf46732211ae44a42cc9c7e8c3b5c9368b0 100644 (file)
@@ -8,9 +8,9 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>tag</b> [<u>options</u>...] +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>search-term</u>&gt; [...]
+       <b>notmuch</b> <b>tag</b> [options ...] +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [--] &lt;<u>search-term</u>&gt; ...
 
-       <b>notmuch</b> <b>tag</b> --batch [ --input=&lt;<u>filename</u>&gt; ]
+       <b>notmuch</b> <b>tag</b> <b>--batch</b> [--input=&lt;<u>filename</u>&gt;]
 </pre>
 
 <h2>DESCRIPTION</h2>
        specify a &quot;--&quot; argument to separate the tags from the search terms.
 
        <b>notmuch</b> <b>tag</b> updates the maildir flags according to tag changes  if  the
-       <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <a href='../notmuch-config-1/'>notmuch-</a>
-       <a href='../notmuch-config-1/'>config</a>(1) for details.
+       <b>maildir.synchronize</b>_<b>flags</b>  configuration  option  is  enabled. See <a href='../notmuch-config-1/'>not-</a>
+       <a href='../notmuch-config-1/'>much-config</a>(1) for details.
 
        Supported options for <b>tag</b> include
 
            <b>--remove-all</b>
 
-               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.
 
            <b>--batch</b>
 
-               Read batch tagging operations from a file (stdin  by  default).
-               This  is  more efficient than repeated <b>notmuch</b> <b>tag</b> invocations.
-               See <b>TAG</b> <b>FILE</b> <b>FORMAT</b> 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 <b>notmuch</b> <b>tag</b>
+                  invocations. See <u>TAG</u> <u>FILE</u> <u>FORMAT</u> below for the input format.
+                  This option is not compatible with specifying tagging on the
+                  command line.
 
-           <b>--input=</b>&lt;filename&gt;
+           <b>--input=</b>&lt<b>&</b>lt;<b>filename</b>&gt<b>&</b>gt;
 
-               Read  input  from  given  file,  instead of from stdin. Implies
-               <b>--batch</b>.
+                  Read input from given file, instead of from  stdin.  Implies
+                  --batch.
 </pre>
 
 <h2>TAG FILE FORMAT</h2>
 
        +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>query</u>&gt;
 
-       Each  line  is  interpreted  similarly  to  <b>notmuch</b>  <b>tag</b>  command  line
-       arguments.  The  delimiter is one or more spaces &apos; &apos;. Any characters in
-       &lt;<u>tag</u>&gt; <b>may</b> 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 &lt;tag&gt; <b>must</b> be hex-encoded  as
-       %20. Any characters that are not part of &lt;<u>tag</u>&gt; <b>must</b> <b>not</b> be hex-encoded.
+       Each  line  is  interpreted similarly to <b>notmuch</b> <b>tag</b> command line argu-
+       ments. The delimiter is one or more spaces &apos; &apos;. Any characters in &lt;<u>tag</u>&gt;
+       <b>may</b>  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 &lt;tag&gt; <b>must</b> be hex-encoded as %20.
+       Any characters that are not part of &lt;<u>tag</u>&gt; <b>must</b> <b>not</b> be hex-encoded.
 
        In the future tag:&quot;tag with spaces&quot; style quoting may be supported  for
        &lt;<u>tag</u>&gt;  as  well;  for  this reason all double quote characters in &lt;<u>tag</u>&gt;
        The  following shows a valid input to batch tagging. Note that only the
        isolated &apos;*&apos; acts as a wildcard. Also note the two  different  quotings
        of the tag <b>space</b> <b>in</b> <b>tags</b>
-              +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 &apos;(tags)&apos;, among other stunts.
-              +crazy{ +(tags) +&amp;are +#possible -- tag:&quot;space in tags&quot;
-              +match*crazy -- tag:crazy{
-              +some_tag -- id:&quot;this is &quot;&quot;nauty)&quot;&quot;&quot;
+
+       +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 &apos;(tags)&apos;, among other stunts.
+       +crazy{ +(tags) +&amp;are +#possible\ -- tag:&quot;space in tags&quot;
+       +match*crazy -- tag:crazy{
+       +some_tag -- id:&quot;this is &quot;&quot;nauty)&quot;&quot;&quot;
 </pre>
 
 <h2>SEE ALSO</h2>
        <a href='../notmuch-show-1/'>much-show</a>(1),
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.18</h2>