X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=0c353eeb0ae3c1c5ee5f5861a4893828ce910182;hp=355d9c41e8e4f9113fa64dda6a1c9503bb10158c;hb=85fe2a1e7df8ccbb172ebf5f10e3cf574a08944a;hpb=82a6b98a10839f24d79526eb2fed8ddb1f87eb14 diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 355d9c4..0c353ee 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -50,9 +50,9 @@ --config=FILE Specify the configuration file to use. This overrides any con‐ - figuration file specified by ${NOTMUCH_CONFIG}. The empty string - is a permitted and sometimes useful value of FILE, which tells - notmuch to use only configuration metadata from the database. + figuration file specified by NOTMUCH_CONFIG. The empty string is + a permitted and sometimes useful value of FILE, which tells not- + much to use only configuration metadata from the database. --uuid=HEX Enforce that the database UUID (a unique identifier which per‐ @@ -76,7 +76,7 @@ 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 can run notmuch setup again to change the configuration. @@ -90,7 +90,7 @@ 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 . + with a utility such as mb2md(1) before running notmuch setup. Invoking notmuch with no command argument will run setup if the setup command has not previously been completed. @@ -99,38 +99,39 @@

  OTHER COMMANDS

        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. 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
-       email database.
+       The  notmuch-search(1),  notmuch-show(1),  notmuch-address(1)  and not‐
+       much-count(1) commands are used to query the email database.
 
-       The reply command is useful for preparing a template for an  email  re‐
-       ply.
+       The notmuch-reply(1) command is useful for preparing a template for  an
+       email reply.
 
-       The tag command is the only command available for manipulating database
-       contents.
+       The notmuch-tag(1) command is the only command available for manipulat‐
+       ing database contents.
 
-       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 notmuch-dump(1) and notmuch-restore(1) commands can be used to cre‐
+       ate  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
-       configuration file.
+       The notmuch-config(1) 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.
+       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 command.
+       By design, this does not allow notmuch's own commands to be  overridden
+       using external commands.

  OPTION SYNTAX

        All options accepting an argument can be used with '=' or ':' as a sep‐
-       arator.  Except for boolean options (which would be ambiguous), a space
+       arator. Except for boolean options (which would be ambiguous), a  space
        can also be used as a separator. The following are all equivalent:
 
           notmuch --config=alt-config config get user.name
@@ -144,9 +145,16 @@
        of notmuch.
 
        NOTMUCH_CONFIG
-              Specifies  the  location of the notmuch configuration file. Not‐
-              much will use ${HOME}/.notmuch-config if this  variable  is  not
-              set.
+              Specifies the location of the notmuch  configuration  file.  See
+              notmuch-config(1) for details.
+
+       NOTMUCH_DATABASE
+              Specifies the location of the notmuch database. See notmuch-con‐
+              fig(1) for details.
+
+       NOTMUCH_PROFILE
+              Selects among notmuch configurations. See notmuch-config(1)  for
+              details.
 
        NOTMUCH_TALLOC_REPORT
               Location  to  write a talloc memory usage report. See talloc_en-
@@ -188,4 +196,4 @@
        2009-2021, Carl Worth and many others
-

0.32

+

0.33