]> git.notmuchmail.org Git - notmuch/commitdiff
man: Document 'config list' command
authorPeter Wang <novalazy@gmail.com>
Sat, 14 Apr 2012 01:41:06 +0000 (11:41 +1000)
committerDavid Bremner <bremner@debian.org>
Sat, 28 Apr 2012 13:47:27 +0000 (10:47 -0300)
Document the 'config list' command and its output.

man/man1/notmuch-config.1

index 395cb9c4e1d320ae0bb9dd99e4a6b60c7362d38d..a55dbef5ad111aa89d7c741db60694cf059750d4 100644 (file)
@@ -9,6 +9,8 @@ notmuch-config \- Access notmuch configuration file.
 .B notmuch config set
 .RI  "<" section ">.<" item "> [" value " ...]"
 
+.B notmuch config list
+
 .SH DESCRIPTION
 
 The
@@ -35,6 +37,18 @@ If no values are provided, the specified configuration item will be
 removed from the configuration file.
 .RE
 
+.RS 4
+.TP 4
+.B list
+Every configuration item is printed to stdout, each on a separate line
+of the form:
+
+.RI  "" section "." item "=" value
+
+No additional whitespace surrounds the dot or equals sign characters. In a
+multiple-value item (a list), the values are separated by semicolon characters.
+.RE
+
 The available configuration items are described below.
 
 .RS 4