From dee880643fd8d50e6c67bda0b8a43d37545efb5b Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Fri, 29 Mar 2013 23:33:37 +0200 Subject: [PATCH] cosmic --- manpages/notmuch-1.mdwn | 62 ++++++++++++++++++--------- manpages/notmuch-count-1.mdwn | 4 +- manpages/notmuch-dump-1.mdwn | 16 ++++--- manpages/notmuch-reply-1.mdwn | 8 +++- manpages/notmuch-restore-1.mdwn | 8 ++-- manpages/notmuch-search-1.mdwn | 4 +- manpages/notmuch-search-terms-7.mdwn | 64 ++++++++++++++-------------- manpages/notmuch-setup-1.mdwn | 62 ++++++++++++++++++--------- manpages/notmuch-show-1.mdwn | 33 ++++++++------ news/release-0.15.1.mdwn | 2 +- news/release-0.15.2.mdwn | 2 +- remoteusage/aboriginal.mdwn | 15 +++++-- 12 files changed, 172 insertions(+), 108 deletions(-) diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 131258d..aee3d3d 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -7,7 +7,7 @@

SYNOPSIS

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

DESCRIPTION

@@ -37,55 +37,73 @@ the most widely used at this time. +

OPTIONS

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

COMMANDS

  SETUP

-       The notmuch setup command is used to configure Notmuch for  first  use,
+       The  notmuch  setup command is used to configure Notmuch for first use,
        (or to reconfigure it later).
 
-       The  setup  command  will prompt for your full name, your primary email
-       address, any alternate email addresses you use, and the directory  con-
+       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  .
+       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
+       ing  it  easy to edit by hand later to change the configuration. Or you
        can run notmuch setup again to change the configuration.
 
-       The  mail  directory you specify can contain any number of sub-directo-
+       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)
+       sages (eg. maildir or mh archives are perfect).  If  there  are  other,
+       non-email  files  (such  as indexes maintained by other email programs)
        then notmuch will do its best to detect those and ignore them.
 
-       Mail  storage that uses mbox format, (where one mbox file contains many
-       messages), will not work with notmuch. If that's how your mail is  cur-
+       Mail storage that uses mbox format, (where one mbox file contains  many
+       messages),  will not work with notmuch. If that's how your mail is cur-
        rently stored, it is recommended you first convert it to maildir format
        with a utility such as mb2md before running notmuch setup .
 
-       Invoking notmuch with no command argument will run setup if  the  setup
+       Invoking  notmuch  with no command argument will run setup if the setup
        command has not previously been completed.

  OTHER COMMANDS

-       Several  of the notmuch commands accept search terms with a common syn-
+       Several of the notmuch commands accept search terms with a common  syn-
        tax. See notmuch-search-terms(7) for more details on the supported syn-
        tax.
 
-       The  search,  show  and  count  commands  are  used  to query the email
-       database.
+       The search, show and count commands are used to query the  email  data-
+       base.
 
-       The reply command is useful for  preparing  a  template  for  an  email
+       The  reply  command  is  useful  for  preparing a template for an email
        reply.
 
        The tag command is the only command available for manipulating database
        contents.
 
-       The dump and restore commands can be used to create a textual  dump  of
+       The  dump  and restore commands can be used to create a textual dump of
        email tags for backup purposes, and to restore from that dump.
 
-       The  config  command can be used to get or set settings int the notmuch
+       The config command can be used to get or set settings int  the  notmuch
        configuration file.
@@ -95,9 +113,13 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not- - much will use ${HOME}/.notmuch-config if this variable is not + Specifies the location of the notmuch configuration file. Not- + much will use ${HOME}/.notmuch-config if this variable is not set. + + NOTMUCH_TALLOC_REPORT + Location to write a talloc memory usage report. See tal- + loc_enable_leak_report_full in talloc(3) for more information.

SEE ALSO

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 7efe493..bba9628 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -16,8 +16,8 @@ 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 notmuch-search-terms(7) for details of the supported syntax for <search-terms>. diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 2f4db7f..1325c34 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -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. - sup The sup dump file format is specifically chosen to be compati- + sup + + The sup dump file format is specifically chosen to be compati- ble with the format of files produced by sup-dump. So if you've previously been using sup for mail, then the notmuch restore command provides you a way to import all of your tags @@ -52,12 +54,12 @@ Tags are hex-encoded by replacing every byte not matching the regex [A-Za-z0-9@=.,_+-] with %nn where nn is the two digit hex encoding. The message ID is a valid Xapian query, quoted using - Xapian boolean term quoting rules: if the ID contains whites- - pace or a close paren or starts with a double quote, it must be - enclosed in double quotes and double quotes inside the ID must - be doubled. The astute reader will notice this is a special - case of the batch input format for notmuch-tag(1); note that - the single message-id query is mandatory for notmuch- + Xapian boolean term quoting rules: if the ID contains white- + space or a close paren or starts with a double quote, it must + be enclosed in double quotes and double quotes inside the ID + must be doubled. The astute reader will notice this is a spe- + cial case of the batch input format for notmuch-tag(1); note + that the single message-id query is mandatory for notmuch- restore(1). With no search terms, a dump of all messages in the database will diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 41320dc..b5be84f 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -79,8 +79,12 @@ Decrypt any MIME encrypted parts found in the selected con- tent (ie. "multipart/encrypted" parts). Status of the decryption will be reported (currently only supported with - --format=json and --format=sexp) and 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 gpg-agent(1) to provide any + needed credentials. Without one, the decryption will fail. See notmuch-search-terms(7) for details of the supported syntax for <search-terms>. diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index a01cb38..acc3960 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -32,7 +32,9 @@ line specifying a message-id and a set of tags. For details of the actual formats, see notmuch-dump(1). - sup The sup dump file format is specifically chosen to be com- + sup + + The sup dump file format is specifically chosen to be com- patible with the format of files produced by sup-dump. So if you've previously been using sup for mail, then the not- much restore command provides you a way to import all of @@ -41,8 +43,8 @@ batch-tag The batch-tag dump format is intended to more robust - against malformed message-ids and tags containing whites- - pace or non-ascii(7) characters. See notmuch-dump(1) for + against malformed message-ids and tags containing white- + space or non-ascii(7) characters. See notmuch-dump(1) for details on this format. notmuch restore updates the maildir flags according to tag diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 11c3ba6..b5f5fb0 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -82,8 +82,8 @@ --sort=(newest-first|oldest-first) This option can be used to present results in either chronolog- - ical order (oldest-first) or reverse chronological order - (newest-first). + ical order (oldest-first) or reverse chronological order (new- + est-first). Note: The thread order will be distinct between these two options (beyond being simply reversed). When sorting by old- diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index 634fde4..985548d 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -1,4 +1,4 @@ -

NOTMUCH-SEARCH-TERMS(7)

+

NOTMUCH-SEARCH-TERMS(7)Miscellaneous Information ManualNOTMUCH-SEARCH-TERMS(7)

NAME

@@ -96,59 +96,59 @@
 
             <initial-timestamp>..<final-timestamp>
 
-       Each timestamp is a number representing the  number  of  seconds  since
+       Each  timestamp  is  a  number representing the number of seconds since
        1970-01-01 00:00:00 UTC.
 
-       In  addition  to  individual terms, multiple terms can be combined with
-       Boolean operators ( and, or, not , etc.). Each term in the  query  will
-       be  implicitly  connected  by  a logical AND if no explicit operator is
-       provided, (except that terms with a common prefix  will  be  implicitly
+       In addition to individual terms, multiple terms can  be  combined  with
+       Boolean  operators  ( and, or, not , etc.). Each term in the query will
+       be implicitly connected by a logical AND if  no  explicit  operator  is
+       provided,  (except  that  terms with a common prefix will be implicitly
        combined with OR until we get Xapian defect #402 fixed).
 
-       Parentheses  can also be used to control the combination of the Boolean
-       operators, but will have to be protected  from  interpretation  by  the
-       shell,  (such  as  by  putting quotation marks around any parenthesized
+       Parentheses can also be used to control the combination of the  Boolean
+       operators,  but  will  have  to be protected from interpretation by the
+       shell, (such as by putting quotation  marks  around  any  parenthesized
        expression).

DATE AND TIME SEARCH

-       notmuch understands a variety of standard and natural ways of  express-
+       notmuch  understands a variety of standard and natural ways of express-
        ing dates and times, both in absolute terms ("2012-10-24") and in rela-
-       tive terms ("yesterday"). Any number of relative terms can be  combined
-       ("1  hour  25  minutes") and an absolute date/time can be combined with
-       relative terms to further adjust it. A  non-exhaustive  description  of
+       tive  terms ("yesterday"). Any number of relative terms can be combined
+       ("1 hour 25 minutes") and an absolute date/time can  be  combined  with
+       relative  terms  to  further adjust it. A non-exhaustive description of
        the syntax supported for absolute and relative terms is given below.
 
            The range expression
 
                date:<since>..<until>
 
-               The  above  expression  restricts  the results to only messages
+               The above expression restricts the  results  to  only  messages
                from <since> to <until>, based on the Date: header.
 
                <since> and <until> can describe imprecise times, such as "yes-
-               terday".   In  this case, <since> is taken as the earliest time
-               it could describe (the beginning of yesterday) and  <until>  is
-               taken  as the latest time it could describe (the end of yester-
+               terday".  In this case, <since> is taken as the  earliest  time
+               it  could  describe (the beginning of yesterday) and <until> is
+               taken as the latest time it could describe (the end of  yester-
                day). Similarly, date:january..february matches from the begin-
                ning of January to the end of February.
 
-               Currently,  we  do not support spaces in range expressions. You
+               Currently, we do not support spaces in range  expressions.  You
                can replace the spaces with '_', or (in most cases) '-', or (in
-               some  cases)  leave the spaces out altogether. Examples in this
+               some cases) leave the spaces out altogether. Examples  in  this
                man page use spaces for clarity.
 
                Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's
-               possible  to  specify  date:..<until>  or date:<since>.. to not
-               limit the start or end  time,  respectively.  Pre-1.2.1  Xapian
-               does  not report an error on open ended ranges, but it does not
+               possible to specify date:..<until>  or  date:<since>..  to  not
+               limit  the  start  or  end time, respectively. Pre-1.2.1 Xapian
+               does not report an error on open ended ranges, but it does  not
                work as expected either.
 
-               Entering date:expr without ".."  (for  example  date:yesterday)
-               won't  work,  as  it's not interpreted as a range expression at
-               all. You can achieve the expected  result  by  duplicating  the
-               expr  both  sides of ".."  (for example date:yesterday..yester-
+               Entering  date:expr  without  ".." (for example date:yesterday)
+               won't work, as it's not interpreted as a  range  expression  at
+               all.  You  can  achieve  the expected result by duplicating the
+               expr both sides of ".."  (for  example  date:yesterday..yester-
                day).
 
            Relative date and time
@@ -157,15 +157,15 @@
 
                All refer to past, can be repeated and will be accumulated.
 
-               Units  can  be  abbreviated  to  any length, with the otherwise
+               Units can be abbreviated to  any  length,  with  the  otherwise
                ambiguous single m being m for minutes and M for months.
 
-               Number can also be written out one, two, ..., ten, dozen,  hun-
-               dred.  Additionally,  the  unit  may  be  preceded by "last" or
+               Number  can also be written out one, two, ..., ten, dozen, hun-
+               dred. Additionally, the unit  may  be  preceded  by  "last"  or
                "this" (e.g., "last week" or "this month").
 
-               When combined with absolute date and time,  the  relative  date
-               and  time  specification  will  be  relative from the specified
+               When  combined  with  absolute date and time, the relative date
+               and time specification will  be  relative  from  the  specified
                absolute date and time.
 
                Examples: 5M2d, two weeks
@@ -220,7 +220,7 @@
 
 
SEE ALSO

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

diff --git a/manpages/notmuch-setup-1.mdwn b/manpages/notmuch-setup-1.mdwn
index 131258d..aee3d3d 100644
--- a/manpages/notmuch-setup-1.mdwn
+++ b/manpages/notmuch-setup-1.mdwn
@@ -7,7 +7,7 @@
 
 
SYNOPSIS

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

 
 
DESCRIPTION

@@ -37,55 +37,73 @@
        the most widely used at this time.
+

OPTIONS

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

COMMANDS

  SETUP

-       The notmuch setup command is used to configure Notmuch for  first  use,
+       The  notmuch  setup command is used to configure Notmuch for first use,
        (or to reconfigure it later).
 
-       The  setup  command  will prompt for your full name, your primary email
-       address, any alternate email addresses you use, and the directory  con-
+       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  .
+       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
+       ing  it  easy to edit by hand later to change the configuration. Or you
        can run notmuch setup again to change the configuration.
 
-       The  mail  directory you specify can contain any number of sub-directo-
+       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)
+       sages (eg. maildir or mh archives are perfect).  If  there  are  other,
+       non-email  files  (such  as indexes maintained by other email programs)
        then notmuch will do its best to detect those and ignore them.
 
-       Mail  storage that uses mbox format, (where one mbox file contains many
-       messages), will not work with notmuch. If that's how your mail is  cur-
+       Mail storage that uses mbox format, (where one mbox file contains  many
+       messages),  will not work with notmuch. If that's how your mail is cur-
        rently stored, it is recommended you first convert it to maildir format
        with a utility such as mb2md before running notmuch setup .
 
-       Invoking notmuch with no command argument will run setup if  the  setup
+       Invoking  notmuch  with no command argument will run setup if the setup
        command has not previously been completed.

  OTHER COMMANDS

-       Several  of the notmuch commands accept search terms with a common syn-
+       Several of the notmuch commands accept search terms with a common  syn-
        tax. See notmuch-search-terms(7) for more details on the supported syn-
        tax.
 
-       The  search,  show  and  count  commands  are  used  to query the email
-       database.
+       The search, show and count commands are used to query the  email  data-
+       base.
 
-       The reply command is useful for  preparing  a  template  for  an  email
+       The  reply  command  is  useful  for  preparing a template for an email
        reply.
 
        The tag command is the only command available for manipulating database
        contents.
 
-       The dump and restore commands can be used to create a textual  dump  of
+       The  dump  and restore commands can be used to create a textual dump of
        email tags for backup purposes, and to restore from that dump.
 
-       The  config  command can be used to get or set settings int the notmuch
+       The config command can be used to get or set settings int  the  notmuch
        configuration file.
@@ -95,9 +113,13 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not- - much will use ${HOME}/.notmuch-config if this variable is not + Specifies the location of the notmuch configuration file. Not- + much will use ${HOME}/.notmuch-config if this variable is not set. + + NOTMUCH_TALLOC_REPORT + Location to write a talloc memory usage report. See tal- + loc_enable_leak_report_full in talloc(3) for more information.

SEE ALSO

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index ceac45c..7132848 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -126,35 +126,40 @@ Decrypt any MIME encrypted parts found in the selected content (ie. "multipart/encrypted" parts). Status of the decryption will be reported (currently only supported with --format=json - and --format=sexp) and 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 gpg-agent(1) to provide any + needed credentials. Without one, the decryption will fail. + + Implies --verify. --exclude=(true|false) - Specify whether to omit threads only matching search.tag_ex- - clude from the search results (the default) or not. In either - case the excluded message will be marked with the exclude flag - (except when output=mbox when there is nowhere to put the + Specify whether to omit threads only matching search.tag_ex- + clude from the search results (the default) or not. In either + case the excluded message will be marked with the exclude flag + (except when output=mbox when there is nowhere to put the flag). - If --entire-thread is specified then complete threads are re- + If --entire-thread is specified then complete threads are re- turned regardless (with the excluded flag being set when appro- - priate) but threads that only match in an excluded message are + priate) but threads that only match in an excluded message are not returned when --exclude=true. The default is --exclude=true. --body=(true|false) - If true (the default) notmuch show includes the bodies of the - messages in the output; if false, bodies are omitted. - --body=false is only implemented for the json and sexp formats + If true (the default) notmuch show includes the bodies of the + messages in the output; if false, bodies are omitted. + --body=false is only implemented for the json and sexp formats and it is incompatible with --part >&gt; 0. - This is useful if the caller only needs the headers as body- + This is useful if the caller only needs the headers as body- less output is much faster and substantially smaller. - A common use of notmuch show is to display a single thread of email + A common use of notmuch show is to display a single thread of email messages. For this, use a search term of "thread:<thread-id>" as can be seen in the first column of output from the notmuch search command. @@ -170,7 +175,7 @@

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not-
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not-
        much-hooks(5),  notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
        notmuch-search(1), notmuch-search-terms(7), notmuch-tag(1)
diff --git a/news/release-0.15.1.mdwn b/news/release-0.15.1.mdwn index 56ad2b9..f74584f 100644 --- a/news/release-0.15.1.mdwn +++ b/news/release-0.15.1.mdwn @@ -1,7 +1,7 @@ [[!meta date="2013-01-24"]] Notmuch 0.15.1 (2013-01-24) -========================= +=========================== Internal test framework changes ------------------------------- diff --git a/news/release-0.15.2.mdwn b/news/release-0.15.2.mdwn index 129d5d4..0efe7bf 100644 --- a/news/release-0.15.2.mdwn +++ b/news/release-0.15.2.mdwn @@ -12,4 +12,4 @@ Internal test framework changes ------------------------------- Adjust Emacs test watchdog mechanism to cope with `process-attributes` -being unimplimented. +being unimplemented. diff --git a/remoteusage/aboriginal.mdwn b/remoteusage/aboriginal.mdwn index 540381b..ef462df 100644 --- a/remoteusage/aboriginal.mdwn +++ b/remoteusage/aboriginal.mdwn @@ -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 -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: @@ -16,8 +20,6 @@ There is just one line to that normally needs configuration: the options howto are presented after the script. -## The script - #!/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." +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 @@ -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. -## 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 -- 2.43.0