]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch.rst
doc: add notmuch-properties(7)
[notmuch] / doc / man1 / notmuch.rst
index 3acfbdb436db953f3889e98e75f913135ae06858..358f42e8d5bef9335a9649839b0e73289ddadc61 100644 (file)
@@ -29,7 +29,7 @@ While the command-line program ``notmuch`` provides powerful
 functionality, it does not provide the most convenient interface for
 that functionality. More sophisticated interfaces are expected to be
 built on top of either the command-line interface, or more likely, on
 functionality, it does not provide the most convenient interface for
 that functionality. More sophisticated interfaces are expected to be
 built on top of either the command-line interface, or more likely, on
-top of the notmuch library interface. See http://notmuchmail.org for
+top of the notmuch 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.
 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.
@@ -116,6 +116,29 @@ 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 **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 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
+separator. 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
+
 ENVIRONMENT
 ===========
 
 ENVIRONMENT
 ===========
 
@@ -138,13 +161,24 @@ of notmuch.
 SEE ALSO
 ========
 
 SEE ALSO
 ========
 
-**notmuch-config(1)**, **notmuch-count(1)**, **notmuch-dump(1)**,
-**notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**,
-**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,
-**notmuch-address(1)**
-
-The notmuch website: **http://notmuchmail.org**
+**notmuch-address(1)**,
+**notmuch-compact(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-insert(1)**,
+**notmuch-new(1)**,
+**notmuch-properties(7)**,
+**notmuch-reindex(1)**,
+**notmuch-reply(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**
+
+The notmuch website: **https://notmuchmail.org**
 
 CONTACT
 =======
 
 CONTACT
 =======