X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=f0add24c6754129b4197b0ae3cd69ec9dc8dbaf9;hb=14bd0939d030873725ced673ab2c86fa3b1e6e7f;hp=2e45c93d288e27a3465609cc69d46dc0b2217834;hpb=971fc82cc6d07e9b058d4ade139d9d2145cb5a3f;p=notmuch-wiki
diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn
index 2e45c93..f0add24 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 http://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.
@@ -41,95 +41,131 @@
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
- configuration file specified by ${NOTMUCH_CONFIG}.
+ --help [command-name]
+ 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}. The empty string
+ is a permitted and sometimes useful value of FILE, which tells
+ notmuch to use only configuration metadata from the database.
+
+ --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-
+ much --uuid=HEX subcommand.
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, 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
- reply.
+ The reply command is useful for preparing a template for an email reâ
+ ply.
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.
+ 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.
+
+
+ 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
+ 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
+ notmuch --config alt-config config get user.name
+
+
ENVIRONMENT
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-
- 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-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-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: http://notmuchmail.org
+ The notmuch website: https://notmuchmail.org
CONTACT
@@ -139,7 +175,7 @@
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).
+ (server: irc.libera.net, channel: #notmuch).
AUTHOR
@@ -149,7 +185,7 @@
COPYRIGHT
- 2015, Carl Worth and many others
+ 2009-2021, Carl Worth and many others
-0.20.2
+0.32