X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-1.mdwn;h=9c46fcd0b46f085965c3588438f1bf7f65b39d0d;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=d4c841669b3a99675f6ccd96dad0dfe4bc59722a;hpb=760f12a345a43a282e9286fb2018741c0a59fbc8;p=notmuch-wiki
diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn
index d4c8416..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.
@@ -41,23 +41,25 @@
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 opâ
+ tional 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. 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
- 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 +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,23 +99,44 @@
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 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
+ 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
@@ -122,13 +145,20 @@
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
@@ -139,9 +169,9 @@
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), 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
@@ -153,7 +183,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.chat, channel: #notmuch).
AUTHOR
@@ -163,7 +193,7 @@
COPYRIGHT
- 2009-2016, Carl Worth and many others
+ 2009-2022, Carl Worth and many others
-0.23
+0.35