X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=c86fec719535825b992198ca1485ced9f71d8a0e;hb=fc555c57dce98da6ab3bc92a4831a14c91807b6e;hp=d4c841669b3a99675f6ccd96dad0dfe4bc59722a;hpb=760f12a345a43a282e9286fb2018741c0a59fbc8;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index d4c8416..c86fec7 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -41,23 +41,23 @@
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. + --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 - persists until e.g. the database is compacted) is HEX; exit - with an error if it is not. This is useful to detect rollover - in modification counts on messages. You can find this UUID - using e.g. notmuch count --lastmod + --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- @@ -74,7 +74,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 +88,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 before running notmuch setup . Invoking notmuch with no command argument will run setup if the setup command has not previously been completed. @@ -116,43 +116,64 @@ 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â + ridden using external commands. ++ +
+ 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 ++
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-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-reply(1), notmuch-restore(1), notâ - much-search(1), notmuch-search-terms(7), notmuch-show(1), notâ - much-tag(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: https://notmuchmail.org
- 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).@@ -163,7 +184,7 @@
- 2009-2016, Carl Worth and many others + 2009-2019, Carl Worth and many others-