X-Git-Url: https://git.cworth.org/git?p=obsolete%2Fnotmuch-wiki;a=blobdiff_plain;f=manpages%2Fnotmuch-setup-1.mdwn;h=131258dd8fc37e1b3213e3dbfc16fd5169d34b5e;hp=aee3d3d57be9d63a38d7967c1f9b7275ebe8374c;hb=24d033149e3e920d201ef80b91e06e8ba441f416;hpb=a0cd5d78701ce4b05e1cd5d0b9d92c0557f3b4db
diff --git a/manpages/notmuch-setup-1.mdwn b/manpages/notmuch-setup-1.mdwn
index aee3d3d..131258d 100644
--- a/manpages/notmuch-setup-1.mdwn
+++ b/manpages/notmuch-setup-1.mdwn
@@ -7,7 +7,7 @@
SYNOPSIS
- notmuch [option ...] command [arg ...]
+ notmuch command [args ...]
DESCRIPTION
@@ -37,73 +37,55 @@
the most widely used at this time.
-OPTIONS
-
- 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 con-
- figuration file specified by ${NOTMUCH_CONFIG}.
-
-
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 and count commands are used to query the email data-
- base.
+ The search, show 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 int the notmuch
+ The config command can be used to get or set settings int the notmuch
configuration file.
@@ -113,13 +95,9 @@
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.
SEE ALSO