summary refs log tree commit diff
path: root/cwmrc.5
diff options
context:
space:
mode:
authorokan <okan>2011-06-25 13:12:56 +0000
committerokan <okan>2011-06-25 13:12:56 +0000
commit0573d184f7fe80a1278f66aaf8692361965615bf (patch)
tree5872a712fa98e080a74804d82aa293bd0392420b /cwmrc.5
parentd8747ae7023d5c5e2c6542a835c008b262261e82 (diff)
downloadcwm-0573d184f7fe80a1278f66aaf8692361965615bf.tar.gz
cwm-0573d184f7fe80a1278f66aaf8692361965615bf.tar.xz
cwm-0573d184f7fe80a1278f66aaf8692361965615bf.zip
Since cwm(1) uses the same parser as others in src, document how
comments and line extensions work.  Taken from sthen@'s recent
commit in src.

ok sthen@
Diffstat (limited to 'cwmrc.5')
-rw-r--r--cwmrc.514
1 files changed, 13 insertions, 1 deletions
diff --git a/cwmrc.5 b/cwmrc.5
index 4c0daaf..c7dbf7f 100644
--- a/cwmrc.5
+++ b/cwmrc.5
@@ -24,7 +24,19 @@
 This manual page describes the
 .Xr cwm 1
 configuration file.
-The following options are accepted in the configuration file:
+.Pp
+The current line can be extended over multiple lines using a backslash
+.Pq Sq \e .
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+Care should be taken when commenting out multi-line text:
+the comment is effective until the end of the entire block.
+.Pp
+Arguments containing whitespace should be surrounded by double quotes
+.Pq \&" .
+.Pp
+The following options are accepted:
 .Pp
 .Bl -tag -width Ds -compact
 .It Ic autogroup Ar group windowname