X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=c86fec719535825b992198ca1485ced9f71d8a0e;hb=716bcefd296e3ee39ff65e8ef89e671c9828191d;hp=2e45c93d288e27a3465609cc69d46dc0b2217834;hpb=971fc82cc6d07e9b058d4ade139d9d2145cb5a3f;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 2e45c93..c86fec7 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -31,7 +31,7 @@ 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 https://notmuchmail.org for more about alternate interfaces to notmuch. The emacs-based interface to notmuch (available under emacs/ in the Notmuch source distribution) is probably the most widely used at this time. @@ -41,68 +41,102 @@ 
        Supported global options for notmuch include
 
-          --help Print a synopsis of available commands and exit.
+       --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  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-
+       much --uuid=HEX subcommand.

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, address and count commands  are  used  to  query  the
+       The  search,  show,  address  and  count commands are used to query the
        email database.
 
-       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  in  the  notmuch
+       The  config  command  can be used to get or set settings in the notmuch
        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
@@ -124,21 +158,22 @@
 
 
SEE ALSO

 
-       notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-insert(1),      notmuch-new(1),      notmuch-reply(1),     not‐
-       much-restore(1),   notmuch-search(1),   notmuch-search-terms(7),   not‐
-       much-show(1), notmuch-tag(1), notmuch-address(1)
+       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-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: http://notmuchmail.org
+       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).
 

 
@@ -149,7 +184,7 @@
 
 
COPYRIGHT

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

 
-
0.20.2

+
0.29