X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=c86fec719535825b992198ca1485ced9f71d8a0e;hb=716bcefd296e3ee39ff65e8ef89e671c9828191d;hp=6fe3db346985ad57c10fa0aff2574fbd405eb488;hpb=972d44d9cb20af9363eb251fc6e748912ad0ca32;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 6fe3db3..c86fec7 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -41,23 +41,23 @@ 
        Supported global options for notmuch include
 
-          --help [command-name]
-                 Print a synopsis of available commands  and  exit.   With  an
-                 optional command name, show the man page for that subcommand.
+       --help [command-name]
+              Print a  synopsis  of  available  commands  and  exit.  With  an
+              optional command name, show the man page for that subcommand.
 
-          --version
-                 Print the installed version of notmuch, and exit.
+       --version
+              Print the installed version of notmuch, and exit.
 
-          --config=FILE
-                 Specify  the  configuration  file  to use. This overrides any
-                 configuration file specified by ${NOTMUCH_CONFIG}.
+       --config=FILE
+              Specify  the  configuration file to use. This overrides any con‐
+              figuration file specified by ${NOTMUCH_CONFIG}.
 
-          --uuid=HEX
-                 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. notmuch count --lastmod
+       --uuid=HEX
+              Enforce that the database UUID (a unique identifier  which  per‐
+              sists until e.g. the database is compacted) is HEX; exit with an
+              error if it is not. This is useful to detect rollover in modifi‐
+              cation  counts  on  messages.  You can find this UUID using e.g.
+              notmuch count --lastmod
 
        All global options except --config can also be specified after the com‐
        mand.  For example, notmuch subcommand --uuid=HEX is equivalent to not-
@@ -116,43 +116,64 @@
        configuration file.
+

  CUSTOM COMMANDS

+
+       If the given command is not known to notmuch, notmuch tries to  execute
+       the external notmuch-<subcommand> in ${PATH} instead. This allows users
+       to have their own notmuch related tools to be run via the notmuch  com‐
+       mand. By design, this does not allow notmuch's own commands to be over‐
+       ridden using external commands.
+
+ +

  OPTION SYNTAX

+
+       All options accepting an argument can be used with '=' or ':' as a sep‐
+       arator. For the cases where it's not ambiguous (in particular excluding
+       boolean options), a space can also  be  used.  The  following  are  all
+       equivalent:
+
+          notmuch --config=alt-config config get user.name
+          notmuch --config:alt-config config get user.name
+          notmuch --config alt-config config get user.name
+
+

ENVIRONMENT

        The following environment variables can be used to control the behavior
        of notmuch.
 
        NOTMUCH_CONFIG
-              Specifies  the  location of the notmuch configuration file. Not‐
-              much will use ${HOME}/.notmuch-config if this  variable  is  not
+              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-
+              Location to  write  a  talloc  memory  usage  report.  See  tal-
               loc_enable_leak_report_full in talloc(3) for more information.
 
        NOTMUCH_DEBUG_QUERY
-              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.

SEE ALSO

-       notmuch-address(1),    notmuch-compact(1),    notmuch-config(1),   not‐
+       notmuch-address(1),   notmuch-compact(1),    notmuch-config(1),    not‐
        much-count(1),  notmuch-dump(1),  notmuch-hooks(5),  notmuch-insert(1),
-       notmuch-new(1),      notmuch-reply(1),     notmuch-restore(1),     not‐
-       much-search(1),    notmuch-search-terms(7),    notmuch-show(1),    not‐
-       much-tag(1)
+       notmuch-new(1),   notmuch-properties(7),    notmuch-reindex(1),    not‐
+       much-reply(1),      notmuch-restore(1),     notmuch-search(1),     not‐
+       much-search-terms(7), notmuch-show(1), notmuch-tag(1)
 
        The notmuch website: https://notmuchmail.org

CONTACT

-       Feel  free to send questions, comments, or kudos to the notmuch mailing
-       list <notmuch@notmuchmail.org> . Subscription is  not  required  before
+       Feel free to send questions, comments, or kudos to the notmuch  mailing
+       list  <notmuch@notmuchmail.org>  .  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
+       Real-time interaction with the Notmuch community is available  via  IRC
        (server: irc.freenode.net, channel: #notmuch).
@@ -163,7 +184,7 @@

COPYRIGHT

-       2009-2016, Carl Worth and many others
+       2009-2019, Carl Worth and many others
-

0.23

+

0.29