X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=9c46fcd0b46f085965c3588438f1bf7f65b39d0d;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=a337685d70f57e8351cdfadb59a5292151f721c3;hpb=ed52cd4055a160d4264b71aebe9e4276298da29e;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index a337685..9c46fcd 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -31,8 +31,8 @@ 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 https://notmuchmail.org for more about - alternate interfaces to notmuch. The emacs-based interface to notmuch + much library interface. See https://notmuchmail.org for more about al‐ + ternate 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. @@ -42,15 +42,17 @@ 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. + Print a synopsis of available commands and exit. With an op‐ + tional command name, show the man page for that subcommand. --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}. + 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‐ @@ -74,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. @@ -88,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. @@ -97,40 +99,40 @@

  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
-       reply.
+       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. For the cases where it's not ambiguous (in particular excluding
-       boolean options), a space can also  be  used.  The  following  are  all
-       equivalent:
+       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
           notmuch --config:alt-config config get user.name
@@ -143,38 +145,45 @@
        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  tal-
-              loc_enable_leak_report_full in talloc(3) for more information.
+              Location  to  write a talloc memory usage report. See talloc_en-
+              able_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-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)
+       notmuch-new(1),  notmuch-properties(7), notmuch-reindex(1), notmuch-re‐
+       ply(1), notmuch-restore(1), notmuch-search(1), notmuch-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
-       (server: irc.freenode.net, channel: #notmuch).
+       Real-time  interaction  with the Notmuch community is available via IRC
+       (server: irc.libera.chat, channel: #notmuch).

AUTHOR

@@ -184,7 +193,7 @@

COPYRIGHT

-       2009-2018, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.28

+

0.35