unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Peter Wang <novalazy@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH v4 6/6] man: Document 'config list' command
Date: Sat, 14 Apr 2012 11:41:06 +1000	[thread overview]
Message-ID: <1334367666-10954-7-git-send-email-novalazy@gmail.com> (raw)
In-Reply-To: <1334367666-10954-1-git-send-email-novalazy@gmail.com>

Document the 'config list' command and its output.
---
 man/man1/notmuch-config.1 |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1
index 395cb9c..a55dbef 100644
--- a/man/man1/notmuch-config.1
+++ b/man/man1/notmuch-config.1
@@ -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
-- 
1.7.4.4

  parent reply	other threads:[~2012-04-14  1:44 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-03-20 22:31 [PATCH 1/2] config: Add 'config list' command Peter Wang
2012-03-20 22:31 ` [PATCH 2/2] man: Document " Peter Wang
2012-03-21 18:30 ` [PATCH 1/2] config: Add " Tomi Ollila
2012-03-21 22:52   ` Peter Wang
2012-03-26 15:03   ` Jameson Graef Rollins
2012-03-26 14:56 ` Jameson Graef Rollins
2012-03-30 23:15 ` [PATCH v2] " Peter Wang
2012-03-30 23:15   ` [PATCH v2 1/5] config: Fix free in 'config get' implementation Peter Wang
2012-03-30 23:15   ` [PATCH v2 2/5] test: Add tests for 'config' command Peter Wang
2012-03-31  7:45     ` Mark Walters
2012-03-31 21:47       ` Jameson Graef Rollins
2012-03-30 23:15   ` [PATCH v2 3/5] test: Add broken test for 'config list' Peter Wang
2012-03-30 23:15   ` [PATCH v2 4/5] config: Add 'config list' command Peter Wang
2012-03-30 23:15   ` [PATCH v2 5/5] man: Document " Peter Wang
2012-04-06  1:48 ` [PATCH v3 0/5] Add " Peter Wang
2012-04-06  1:48   ` [PATCH v3 1/5] config: Fix free in 'config get' implementation Peter Wang
2012-04-06  1:48   ` [PATCH v3 2/5] test: Add tests for 'config' command Peter Wang
2012-04-10  7:30     ` Jameson Graef Rollins
2012-04-06  1:48   ` [PATCH v3 3/5] test: Add broken test for 'config list' Peter Wang
2012-04-06  1:48   ` [PATCH v3 4/5] config: Add 'config list' command Peter Wang
2012-04-10  7:22     ` Jameson Graef Rollins
2012-04-10  8:31       ` Peter Wang
2012-04-06  1:48   ` [PATCH v3 5/5] man: Document " Peter Wang
2012-04-14  1:41 ` [PATCH v4 0/6] Config-related patches Peter Wang
2012-04-14  1:41   ` [PATCH v4 1/6] config: Fix free in 'config get' implementation Peter Wang
2012-04-25  2:29     ` David Bremner
2012-04-14  1:41   ` [PATCH v4 2/6] config: Check 'config get' arity exactly Peter Wang
2012-04-28 13:51     ` David Bremner
2012-04-14  1:41   ` [PATCH v4 3/6] test: Add tests for 'config' command Peter Wang
2012-04-14  1:41   ` [PATCH v4 4/6] test: Add broken test for 'config list' Peter Wang
2012-04-14  1:41   ` [PATCH v4 5/6] config: Add 'config list' command Peter Wang
2012-04-14  1:41   ` Peter Wang [this message]
2012-04-14  8:25   ` [PATCH v4 0/6] Config-related patches Mark Walters
2012-04-14 19:33     ` Jameson Graef Rollins
2012-04-25  8:06     ` Mark Walters
2012-04-14 19:32   ` Jameson Graef Rollins

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1334367666-10954-7-git-send-email-novalazy@gmail.com \
    --to=novalazy@gmail.com \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).