summaryrefslogtreecommitdiffstats
path: root/doc/man1
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2017-07-01 12:18:45 -0300
committerDavid Bremner <david@tethera.net>2017-07-12 17:46:29 -0300
commita32dd81a55a5d745dbf840b42d03e835a4e1e45c (patch)
tree09a70a8b3d9675e1129f5f8828a5b809b7353e1a /doc/man1
parentde9baa29dc990e4166b47dc2b0d0cf560014834b (diff)
cli: add space separator for keyword, string, and int arguments
Defer the complication of optional boolean arguments for later (never?).
Diffstat (limited to 'doc/man1')
-rw-r--r--doc/man1/notmuch.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index fbd7f381..5e238ae4 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -125,6 +125,20 @@ 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 overriden 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
===========