]> git.cworth.org Git - notmuch-wiki/commitdiff
cosmic
authorTomi Ollila <tomi.ollila@iki.fi>
Fri, 29 Mar 2013 21:33:37 +0000 (23:33 +0200)
committerTomi Ollila <tomi.ollila@iki.fi>
Fri, 29 Mar 2013 21:33:37 +0000 (23:33 +0200)
12 files changed:
manpages/notmuch-1.mdwn
manpages/notmuch-count-1.mdwn
manpages/notmuch-dump-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
news/release-0.15.1.mdwn
news/release-0.15.2.mdwn
remoteusage/aboriginal.mdwn

index 131258dd8fc37e1b3213e3dbfc16fd5169d34b5e..aee3d3d57be9d63a38d7967c1f9b7275ebe8374c 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <u>command</u> [<u>args</u> ...]
+       <b>notmuch</b> [<u>option</u> ...] <u>command</u> [<u>arg</u> ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
 </pre>
 
 <h2>DESCRIPTION</h2>
        the most widely used at this time.
 </pre>
 
        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>
 <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-
+       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-
        taining your email archives. Your answers will be written to a configu-
-       ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config  .
+       ration  file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
        This configuration file will be created with descriptive comments, mak-
        This configuration file will be created with descriptive comments, mak-
-       ing it easy to edit by hand later to change the configuration.  Or  you
+       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-
+       The mail directory you specify can contain any number  of  sub-directo-
        ries and should primarily contain only files with individual email mes-
        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)
+       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
        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
 
        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  <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-
+       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.
 
        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>search</b>, <b>show</b> and <b>count</b> commands are used to query the  email  data-
+       base.
 
 
-       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 int  the  notmuch
        configuration file.
 </pre>
 
        configuration file.
 </pre>
 
        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.
               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.
 </pre>
 
 <h2>SEE ALSO</h2>
 </pre>
 
 <h2>SEE ALSO</h2>
index 7efe4930a4a1628f5bae830c54ee6e01c535d98c..bba9628ae3ebaa7f0ef1202b8b07129a9cfcabb0 100644 (file)
@@ -16,8 +16,8 @@
 
        The number of matching messages (or threads) is output to stdout.
 
 
        The number of matching messages (or threads) is output to stdout.
 
-       With  no  search  terms,  a  count  of all messages (or threads) in the
-       database will be displayed.
+       With no search terms, a count of all messages (or threads) in the data-
+       base will be displayed.
 
        See <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;.
index 2f4db7f04d8f5c82c745301ac32c0ec0cf14669a..1325c3456b8f8d2d31b5a9d9b5065fd3aa39b11a 100644 (file)
@@ -27,7 +27,9 @@
            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>sup</b>  The <b>sup</b> dump file format is specifically chosen to be compati-
+           <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
                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
                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
                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>
+               Xapian  boolean  term  quoting rules: if the ID contains white-
+               space or a close paren or starts with a double quote,  it  must
+               be  enclosed  in  double quotes and double quotes inside the ID
+               must be doubled.  The astute reader will notice this is a  spe-
+               cial  case  of  the batch input format for <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  no  search terms, a dump of all messages in the database will
                <a href='../notmuch-restore-1/'>restore</a>(1).
 
            With  no  search terms, a dump of all messages in the database will
index 41320dc1383cff6107fcccd84532088b291329b6..b5be84f4c28cb225accec4e13aafd5ac780fe3de 100644 (file)
                   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
                   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 the multipart/encrypted
-                  part will be replaced by the decrypted content.
+                  --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.
 
        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;.
index a01cb3845f920c248e04adcd6a9fa46d5d4adc03..acc396031f2d446807ef20a9f4bfbf17e3b92d1f 100644 (file)
@@ -32,7 +32,9 @@
                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).
 
                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-
+               <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
                    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
@@ -41,8 +43,8 @@
                <b>batch-tag</b>
 
                    The  <b>batch-tag</b>  dump  format  is  intended  to  more robust
                <b>batch-tag</b>
 
                    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
+                   against malformed message-ids and  tags  containing  white-
+                   space  or non-<b>ascii</b>(7) characters.  See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
                    details on this format.
 
                    <b>notmuch</b> <b>restore</b> updates the maildir flags according to  tag
                    details on this format.
 
                    <b>notmuch</b> <b>restore</b> updates the maildir flags according to  tag
index 11c3ba6366fdebda7d1eec55f31d11f1512cc98c..b5f5fb0f02b35c965d16f942ec504ee22229bf43 100644 (file)
@@ -82,8 +82,8 @@
            <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
 
                This option can be used to present results in either chronolog-
            <b>--sort=</b>(<b>newest-first</b>|<b>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>).
+               ical  order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
+               <b>est-first</b>).
 
                Note: The thread order  will  be  distinct  between  these  two
                options  (beyond  being  simply reversed). When sorting by <b>old-</b>
 
                Note: The thread order  will  be  distinct  between  these  two
                options  (beyond  being  simply reversed). When sorting by <b>old-</b>
index 634fde4f647c431c04feac5c10e058ead0d61743..985548d75173d4dbbaf4ee3bfa85539ee53ebc34 100644 (file)
@@ -1,4 +1,4 @@
-<h1>NOTMUCH-SEARCH-TERMS(7)</h1>
+<h1>NOTMUCH-SEARCH-TERMS(7)Miscellaneous Information ManualNOTMUCH-SEARCH-TERMS(7)</h1>
 
 <h2>NAME</h2>
 <pre>
 
 <h2>NAME</h2>
 <pre>
 
             &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
+       Each  timestamp  is  a  number representing the number of seconds since
        1970-01-01 00:00:00 UTC.
 
        1970-01-01 00:00:00 UTC.
 
-       In  addition  to  individual terms, multiple terms can be combined with
-       Boolean operators ( <b>and</b>, <b>or</b>, <b>not</b> , etc.). Each term in the  query  will
-       be  implicitly  connected  by  a logical AND if no explicit operator is
-       provided, (except that terms with a common prefix  will  be  implicitly
+       In addition to individual terms, multiple terms can  be  combined  with
+       Boolean  operators  ( <b>and</b>, <b>or</b>, <b>not</b> , etc.). Each term in the query will
+       be implicitly connected by a logical AND if  no  explicit  operator  is
+       provided,  (except  that  terms with a common prefix will be implicitly
        combined with OR until we get Xapian defect #402 fixed).
 
        combined with OR until we get Xapian defect #402 fixed).
 
-       Parentheses  can also be used to control the combination of the Boolean
-       operators, but will have to be protected  from  interpretation  by  the
-       shell,  (such  as  by  putting quotation marks around any parenthesized
+       Parentheses can also be used to control the combination of the  Boolean
+       operators,  but  will  have  to be protected from interpretation by the
+       shell, (such as by putting quotation  marks  around  any  parenthesized
        expression).
 </pre>
 
 <h2>DATE AND TIME SEARCH</h2>
 <pre>
        expression).
 </pre>
 
 <h2>DATE AND TIME SEARCH</h2>
 <pre>
-       notmuch understands a variety of standard and natural ways of  express-
+       notmuch  understands a variety of standard and natural ways of express-
        ing dates and times, both in absolute terms (&quot;2012-10-24&quot;) and in rela-
        ing dates and times, both in absolute terms (&quot;2012-10-24&quot;) and in rela-
-       tive terms (&quot;yesterday&quot;). Any number of relative terms can be  combined
-       (&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
+       tive  terms (&quot;yesterday&quot;). Any number of relative terms can be combined
+       (&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.
 
            <b>The</b> <b>range</b> <b>expression</b>
 
                date:&lt;since&gt;..&lt;until&gt;
 
        the syntax supported for absolute and relative terms is given below.
 
            <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
+               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;yes-
                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;yes-
-               terday&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 yester-
+               terday&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  yester-
                day). Similarly, date:january..february matches from the begin-
                ning of January to the end of February.
 
                day). Similarly, date:january..february matches from the begin-
                ning of January to the end of February.
 
-               Currently,  we  do not support spaces in range expressions. You
+               Currently, we do not support spaces in range  expressions.  You
                can replace the spaces with &apos;_&apos;, or (in most cases) &apos;-&apos;, or (in
                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
+               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
                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
+               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.
 
                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-
+               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).
 
            <b>Relative</b> <b>date</b> <b>and</b> <b>time</b>
                day).
 
            <b>Relative</b> <b>date</b> <b>and</b> <b>time</b>
 
                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
+               Units can be abbreviated to  any  length,  with  the  otherwise
                ambiguous single m being m for minutes and M for months.
 
                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
+               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;).
 
                &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
+               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
                absolute date and time.
 
                Examples: 5M2d, two weeks
 
 <h2>SEE ALSO</h2>
 <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-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-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>
        <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <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>
index 131258dd8fc37e1b3213e3dbfc16fd5169d34b5e..aee3d3d57be9d63a38d7967c1f9b7275ebe8374c 100644 (file)
@@ -7,7 +7,7 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <u>command</u> [<u>args</u> ...]
+       <b>notmuch</b> [<u>option</u> ...] <u>command</u> [<u>arg</u> ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
 </pre>
 
 <h2>DESCRIPTION</h2>
        the most widely used at this time.
 </pre>
 
        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>
 <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-
+       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-
        taining your email archives. Your answers will be written to a configu-
-       ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config  .
+       ration  file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
        This configuration file will be created with descriptive comments, mak-
        This configuration file will be created with descriptive comments, mak-
-       ing it easy to edit by hand later to change the configuration.  Or  you
+       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-
+       The mail directory you specify can contain any number  of  sub-directo-
        ries and should primarily contain only files with individual email mes-
        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)
+       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
        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
 
        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  <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-
+       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.
 
        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>search</b>, <b>show</b> and <b>count</b> commands are used to query the  email  data-
+       base.
 
 
-       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 int  the  notmuch
        configuration file.
 </pre>
 
        configuration file.
 </pre>
 
        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.
               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.
 </pre>
 
 <h2>SEE ALSO</h2>
 </pre>
 
 <h2>SEE ALSO</h2>
index ceac45c6d6ec4a624ffa2c9dd0fae1df241337a8..7132848d3ae647800efd43144cf1f42d085a2724 100644 (file)
                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
                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 the multipart/encrypted part will be re-
-               placed by the decrypted content.  Implies --verify.
+               and  --format=sexp)  and  on  successful  decryption the multi-
+               part/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.
+
+               Implies --verify.
 
            <b>--exclude=(true|false)</b>
 
 
            <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
+               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).
 
                flag).
 
-               If --entire-thread is specified then complete threads  are  re-
+               If  --entire-thread  is specified then complete threads are re-
                turned regardless (with the excluded flag being set when appro-
                turned regardless (with the excluded flag being set when appro-
-               priate) but threads that only match in an excluded message  are
+               priate)  but threads that only match in an excluded message are
                not returned when <b>--exclude=true.</b>
 
                The default is <b>--exclude=true.</b>
 
            <b>--body=(true|false)</b>
 
                not returned when <b>--exclude=true.</b>
 
                The default is <b>--exclude=true.</b>
 
            <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
+               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>
 
                and it is incompatible with <b>--part</b> &gt<b>&</b>gt; <b>0.</b>
 
-               This is useful if the caller only needs the  headers  as  body-
+               This  is  useful  if the caller only needs the headers as body-
                less output is much faster and substantially smaller.
 
                less output is much faster and substantially smaller.
 
-       A  common  use  of  <b>notmuch</b> <b>show</b> is to display a single thread of email
+       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
        seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
 </pre>
        messages. For this, use a search term of &quot;thread:&lt;thread-id&gt;&quot; as can be
        seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
 </pre>
 
 <h2>SEE ALSO</h2>
 <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-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-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-tag-1/'>notmuch-tag</a>(1)
 </pre>
        <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <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-tag-1/'>notmuch-tag</a>(1)
 </pre>
index 56ad2b924ff9588e5fd991870ae044b9fd6a4a68..f74584f71a5b2e35e266d4ceccb927bf255e18da 100644 (file)
@@ -1,7 +1,7 @@
 [[!meta date="2013-01-24"]]
 
 Notmuch 0.15.1 (2013-01-24)
 [[!meta date="2013-01-24"]]
 
 Notmuch 0.15.1 (2013-01-24)
-=========================
+===========================
 
 Internal test framework changes
 -------------------------------
 
 Internal test framework changes
 -------------------------------
index 129d5d4cdfb954d760ef4cdbd78cecd93ef49aac..0efe7bf344bb764407ebf0c896d0b082ff1c3387 100644 (file)
@@ -12,4 +12,4 @@ Internal test framework changes
 -------------------------------
 
 Adjust Emacs test watchdog mechanism to cope with `process-attributes`
 -------------------------------
 
 Adjust Emacs test watchdog mechanism to cope with `process-attributes`
-being unimplimented.
+being unimplemented.
index 540381b752913109112f8140ba7cd1054a5bfcdd..ef462dfee9159c60e757ec330b45a2016781e5a8 100644 (file)
@@ -7,7 +7,11 @@ other requirements and general information.
 This solution uses one pre-made ssh connection where the client is put
 into "master" mode (-M) for connection sharing. The wrapper script then
 uses the control socket created by this pre-made ssh connection for
 This solution uses one pre-made ssh connection where the client is put
 into "master" mode (-M) for connection sharing. The wrapper script then
 uses the control socket created by this pre-made ssh connection for
-its own connection.
+its own connection. As long as master ssh connection is live, slave
+can use it. Disconnecting master all future attempts to connect
+from the script will fail.
+
+## The script
 
 Write the following code to a file, for example `remote-notmuch.sh`.
 There is just one line to that normally needs configuration:
 
 Write the following code to a file, for example `remote-notmuch.sh`.
 There is just one line to that normally needs configuration:
@@ -16,8 +20,6 @@ There is just one line to that normally needs configuration:
 
 the options howto are presented after the script.
 
 
 the options howto are presented after the script.
 
-## The script
-
         #!/bin/bash
 
         # http://notmuchmail.org/remoteusage/aboriginal/
         #!/bin/bash
 
         # http://notmuchmail.org/remoteusage/aboriginal/
@@ -55,6 +57,11 @@ the options howto are presented after the script.
 
         echo " See`sed '1d;2d;s/.//;q' "$0"` for help."
 
 
         echo " See`sed '1d;2d;s/.//;q' "$0"` for help."
 
+Note the `0.1` in ssh command line. It is used to avoid any opportunistic
+behaviour ssh might do; for example if control socket is not alive ssh
+would attempt to do it's own ssh connection to remote ssh server. As
+address `0.1` is invalid this attempt will fail early.
+
 ## Test
 
 Easiest way to test this script is to run the pre-made ssh connection
 ## Test
 
 Easiest way to test this script is to run the pre-made ssh connection
@@ -72,7 +79,7 @@ case shell never expand it to `$HOME` -- ssh does it by not reading
 `$HOME` but checking the real user home directory from `/etc/passewd`.
 For security purposes this is just how it should be.
 
 `$HOME` but checking the real user home directory from `/etc/passewd`.
 For security purposes this is just how it should be.
 
-## Tunkkaa
+## Tune
 
 The path `'~'/.ssh/master-user@host:22` might look too generic to be
 used as is as the control socket after initial testing (but it can
 
 The path `'~'/.ssh/master-user@host:22` might look too generic to be
 used as is as the control socket after initial testing (but it can