cosmic

[notmuch-wiki] / manpages / notmuch-1.mdwn

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn
index 5359098d8f2c1c05fa86bd8c02e3b7acfd2b2c36..d4c841669b3a99675f6ccd96dad0dfe4bc59722a 100644 (file)
--- a/manpages/notmuch-1.mdwn
+++ b/manpages/notmuch-1.mdwn
@@ -7,17 +7,17 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
 
 <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>
 <pre>
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>

-       Notmuch  is a command-line based program for indexing, searching, read-
+       Notmuch  is a command-line based program for indexing, searching, read‐

        ing, and tagging large collections of email messages.
 
        This page describes how to get started using notmuch from  the  command
        line,  and  gives  a brief overview of the commands available. For more
        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,
+       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
        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


@@ -28,10 +28,10 @@
 <h2>NOTE</h2>
 <pre>
        While the command-line program <b>notmuch</b> provides powerful functionality,
 <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-
+       it does not provide the most convenient interface for that  functional‐

        ity.  More  sophisticated interfaces are expected to be built on top of
        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
+       either the command-line interface, or more likely, on top of  the  not‐
+       much  library  interface.  See  <u>https://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.
        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.


@@ -41,69 +41,78 @@
 <pre>
        Supported global options for <b>notmuch</b> include
 
 <pre>
        Supported global options for <b>notmuch</b> include
 

-           <b>--help</b>
+          <b>--help</b> <b>[command-name]</b>
+                 Print a synopsis of available commands  and  exit.   With  an
+                 optional command name, show the man page for that subcommand.

 
 

-               Print a synopsis of available commands and exit.
+          <b>--version</b>
+                 Print the installed version of notmuch, and exit.

 
 

-           <b>--version</b>
+          <b>--config=FILE</b>
+                 Specify  the  configuration  file  to use. This overrides any
+                 configuration file specified by ${NOTMUCH_CONFIG}.

 
 

-               Print the installed version of notmuch, and exit.
+          <b>--uuid=HEX</b>
+                 Enforce that the database UUID  (a  unique  identifier  which
+                 persists  until  e.g. the database is compacted) is HEX; exit
+                 with an error if it is not. This is useful to detect rollover
+                 in  modification  counts  on messages. You can find this UUID
+                 using e.g. <b>notmuch</b> <b>count</b> <b>--lastmod</b>

 
 

-           <b>--config=FILE</b>
-
-               Specify the configuration file to use. This overrides any  con-
-               figuration file specified by ${NOTMUCH_CONFIG}.
+       All global options except <b>--config</b> can also be specified after the com‐
+       mand.  For example, <b>notmuch</b> <b>subcommand</b> <b>--uuid=HEX</b> is equivalent to <b>not-</b>
+       <b>much</b> <b>--uuid=HEX</b> <b>subcommand</b>.

 </pre>
 
 <h2>COMMANDS</h2>
 
 <h3> &nbsp; SETUP</h3>
 <pre>
 </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,
+       The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for  first  use,

        (or to reconfigure it later).
 
        (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
+       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.
 
        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)
+       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.
 
        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-
+       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
        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>
+       with a utility such as mb2md before running <b>notmuch</b> <b>setup</b>.

 
 

-       Invoking  <b>notmuch</b>  with no command argument will run <b>setup</b> if the setup
+       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>
        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-
+       Several  of the notmuch commands accept search terms with a common syn‐
+       tax. See <b>notmuch-search-terms</b>(7) for more details on the supported syn‐

        tax.
 
        tax.
 

-       The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the  email  data-
-       base.
+       The  <b>search</b>,  <b>show</b>,  <b>address</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
+       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.
 
        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
+       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.
 
        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>
 
        configuration file.
 </pre>
 


@@ -113,37 +122,48 @@
        of notmuch.
 
        <b>NOTMUCH</b>_<b>CONFIG</b>
        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.
 
        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
               set.
 
        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>

-              Location to  write  a  talloc  memory  usage  report.  See  <b>tal-</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>
               <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
+              If set to a non-empty value, the notmuch library will print  (to

               stderr) Xapian queries it constructs.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
               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-address-1/'>notmuch-address</a>(1),    <a href='../notmuch-compact-1/'>notmuch-compact</a>(1),    <a href='../notmuch-config-1/'>notmuch-config</a>(1),   <a href='../notmuch-count-1/'>not‐</a>
+       <a href='../notmuch-count-1/'>much-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-restore</a>(1),     <a href='../notmuch-search-1/'>not‐</a>
+       <a href='../notmuch-search-1/'>much-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)

 
 

-       The notmuch website: <b>http://notmuchmail.org</b>
+       The notmuch website: <b>https://notmuchmail.org</b>

 </pre>
 
 <h2>CONTACT</h2>
 <pre>
        Feel  free to send questions, comments, or kudos to the notmuch mailing
 </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>
 
        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.16</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2009-2016, Carl Worth and many others
+</pre>
+
+<h2>0.23</h2>