[Pkg-wmaker-commits] [wmix] 07/44: wmix: added description of the syntax of the config file in the man page

[Doug Torrance]

This is an automated email from the git hooks/post-receive script.

dtorrance-guest pushed a commit to branch upstream
in repository wmix.

commit ccc7b548d8a4b1c8f46762ff7f24e5488bd45729
Author: Christophe CURIS <christophe.curis at free.fr>
Date:   Sat Jun 7 21:21:35 2014 +0200

    wmix: added description of the syntax of the config file in the man page
    
    Signed-off-by: Christophe CURIS <christophe.curis at free.fr>
---
 INSTALL       |  5 +++--
 README        |  4 ++--
 sample.wmixrc |  2 +-
 wmix.1x       | 40 ++++++++++++++++++++++++++++++++++++++++
 4 files changed, 46 insertions(+), 5 deletions(-)

diff --git a/INSTALL b/INSTALL
index 6301f0d..46f0d2d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -5,7 +5,8 @@ Since your reading this, you are probably done with the tar zxvf part.
 3. make install
 4. wmix
 
-pretty easy.  See README for instructions on how to use the mixer and about
-some information on the programming involved.
+pretty easy. See README for instructions on how to use the mixer and about
+some information on the programming involved. See the man page (man wmix)
+for invocation and configuration information.
 
 timecop [timecop at japan.co.jp]
diff --git a/README b/README
index 82446f3..7941eda 100644
--- a/README
+++ b/README
@@ -87,7 +87,7 @@ wheelstep=3			# the step for mousewheel adjustment
 
 Most defaults are good for normal use, and if there is no config file,
 the settings you see above are used. If you want to hack on a config file,
-copy sample.wmixrc to ~/.wmixrc and change it around. Comments are ignored,
-but don't put comments at the end of line like I did here.
+copy sample.wmixrc to ~/.wmixrc and change it around. You can find
+complete description of the format in than man page.
 
 timecop [timecop at japan.co.jp]
diff --git a/sample.wmixrc b/sample.wmixrc
index a22fb9a..d87bc3c 100644
--- a/sample.wmixrc
+++ b/sample.wmixrc
@@ -6,7 +6,7 @@ mousewheel=1
 scrolltext=1
 # display OSD
 osd=1
-# color of the OSD (from rgb.txt or #xxxxxx)
+# color of the OSD (from rgb.txt or rgb:xx/xx/xx)
 osdcolor=green
 # which mousewheel button is "up"
 wheelbtn1=4
diff --git a/wmix.1x b/wmix.1x
index 31cb555..5892422 100644
--- a/wmix.1x
+++ b/wmix.1x
@@ -40,7 +40,47 @@ Use specified mixer device instead of
 \fB\-v\fR
 Verbose start, report detected channels
 .
+.SH CONFIGURATION FILE
+If readable, the file \fI~/.wmixrc\fP (or the file specified through \fB\-f\fR option)
+is read on startup.
+It may contains one configuration command per line:
+.TP
+mousewheel=<\fI0\fP|\fI1\fP>
+when set to \fI0\fP, disable the volume control through mouse wheel (default=\fI1\fP)
+.TP
+osd=<\fI0\fP|\fI1\fP>
+when set to \fI0\fP, disable display of the volume in an OSD like fashion (default=\fI1\fP)
+.TP
+osdcolor=<\fIcolor\fP>
+specify the color to use for OSD volume display.
+It can be the name of a color (see \fI/usr/share/X11/rgb.txt\fP)
+or an RGB specification (as \fBrgb:\fP<\fIred\fP>/<\fIgreen\fP>/<\fIblue\fP>
+with hexadecimal numbers) as expected by X11 (default=\fIgreen\fP)
+.TP
+scrolltext=<\fI0\fP|\fI1\fP>
+when set to \fI0\fP, disable text scrolling to display the name of current selected
+channel, use static short name instead (default=\fI1\fP)
+.TP
+wheelbtn1=<\fIbutton\fP>
+.TQ
+wheelbtn2=<\fIbutton\fP>
+defines the buttons events associated in X11 to the mouse wheel,
+with \fIbtn1\fP for up and \fIbtn2\fP for down
+(default: btn1=\fI4\fP and btn2=\fI5\fP)
+.TP
+wheelstep=<\fIpercentage\fP>
+sets the volume change step when using the mouse wheel,
+specified as a percentage of the total volume range (i.e.: 1\~<\~\fIvalue\fP\~<\~100,
+default=\fI3\fP)
+.br
+For compatibility, values between 0.0 and 1.0 will be considered as a raw percentage
+.LP
+.
 .SH FILES
+.TP
+.I ~/.wmixrc
+User configuration file (change with option
+.BR \-f )
 .LP
 See \fI/usr/share/doc/wmix/README.gz\fP for more information
 .

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-wmaker/wmix.git