X-Git-Url: https://git.cworth.org/git?p=obsolete%2Fnotmuch-wiki;a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=5359098d8f2c1c05fa86bd8c02e3b7acfd2b2c36;hp=131258dd8fc37e1b3213e3dbfc16fd5169d34b5e;hb=HEAD;hpb=db09ec4bfe12f883997a17e7a06ccee2d5ce7296 diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 131258d..5359098 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,16 +113,25 @@ 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. + + NOTMUCH_DEBUG_QUERY + If set to a non-empty value, the notmuch library will print (to + stderr) Xapian queries it constructs.

SEE ALSO

        notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-new(1),    notmuch-reply(1),    notmuch-restore(1),    notmuch-
-       search(1), notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
+       notmuch-insert(1),     notmuch-new(1),    notmuch-reply(1),    notmuch-
+       restore(1),   notmuch-search(1),   notmuch-search-terms(7),    notmuch-
+       show(1), notmuch-tag(1)
 
        The notmuch website: http://notmuchmail.org
@@ -119,4 +146,4 @@ (server: irc.freenode.net, channel: #notmuch). -

Notmuch 0.15.2

+

Notmuch 0.16