X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=da44ca94f1bf151deb1b8f375e2872cf167dc924;hb=46b88668029f0f014c4ecf7a220b7a99a13776f3;hp=898e9e036e8ef7f3d77297f7437448ff5b254d2b;hpb=463553b46f63067f5b25a6115f116d88f02d50ec;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 898e9e0..da44ca9 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. @@ -49,7 +49,7 @@ Print the installed version of notmuch, and exit. --config=FILE - Specify the configuration file to use. This overrides any + Specify the configuration file to use. This overrides any configuration file specified by ${NOTMUCH_CONFIG}. --uuid=HEX @@ -68,81 +68,91 @@
- 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.
- 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.+
+ 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â + riden using external commands. ++
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.
- 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-reply(1), notmuch-restore(1), notâ + much-search(1), notmuch-search-terms(7), notmuch-show(1), notâ + much-tag(1) - The notmuch website: http://notmuchmail.org + The notmuch website: https://notmuchmail.org
- 2009-2016, Carl Worth and many others + 2009-2017, Carl Worth and many others-