summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrzej Rybczak <electricityispower@gmail.com>2014-09-14 14:09:34 +0200
committerAndrzej Rybczak <electricityispower@gmail.com>2014-09-14 14:13:16 +0200
commit5dc36a0c504b3b2417b2ec2b2d108439a1736f0f (patch)
tree5ef5613a703a58b4900551f770e638a1365d808a /doc
parent67f2903c42289cb2971868928b7a5b210ce4ac65 (diff)
man: describe parsing rules for configuration values
Diffstat (limited to 'doc')
-rw-r--r--doc/ncmpcpp.16
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/ncmpcpp.1 b/doc/ncmpcpp.1
index 6e8ef2f8..8e933413 100644
--- a/doc/ncmpcpp.1
+++ b/doc/ncmpcpp.1
@@ -30,7 +30,11 @@ Display version information.
.SH "CONFIGURATION"
When ncmpcpp starts, it tries to read user's settings from the ~/.ncmpcpp/config file. If no user's configuration is found, ncmpcpp uses its default configuration. An example configuration file containing all default values is provided with ncmpcpp and can be usually found in /usr/share/doc/ncmpcpp (exact location may depend on used distribution or configure prefix).
-Note: Each config option value must be enclosed in quotation marks (var = "example"). If you want to use quotation mark inside config option, prepend character '\\' to it.
+Note: Configuration option values can either be enclosed in quotation marks or not.
+ - If they are enclosed, the leftmost and the rightmost quotation marks are treated as delimiters, therefore it is not necessary to escape quotation marks you use within the value itself.
+ - If they are not, any whitespace characters between = and the first printable character of the value, as well as whitespace characters after the last printable character of the value are trimmed.
+
+Therefore the rule of thumb is: if you need whitespaces at the beginning or at the end of the value, enclose it in quotation marks. Otherwise, don't.
Note: COLOR has to be the name (not a number) of one of colors 1-8 from SONG FORMAT section.