snow/dockapps
1
0
Fork 0
Code Issues Releases Activity

wmix: added description of the syntax of the config file in the man page

Browse source 
Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
Christophe CURIS 2014-06-07 21:21:35 +02:00 committed by Carlos R. Mafra
parent 8e7c63282c
commit 46199b9170
4 changed files with 46 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
wmix/INSTALL
View file

@ -5,7 +5,8 @@ Since your reading this, you are probably done with the tar zxvf part.
3. make install 3. make install
4. wmix 4. wmix
pretty easy. See README for instructions on how to use the mixer and about pretty easy. See README for instructions on how to use the mixer and about
some information on the programming involved. some information on the programming involved. See the man page (man wmix)
for invocation and configuration information.
timecop [timecop@japan.co.jp] timecop [timecop@japan.co.jp]

4
wmix/README
View file

@ -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, 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, 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, copy sample.wmixrc to ~/.wmixrc and change it around. You can find
but don't put comments at the end of line like I did here. complete description of the format in than man page.
timecop [timecop@japan.co.jp] timecop [timecop@japan.co.jp]

2
wmix/sample.wmixrc
View file

@ -6,7 +6,7 @@ mousewheel=1
scrolltext=1 scrolltext=1
# display OSD # display OSD
osd=1 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 osdcolor=green
# which mousewheel button is "up" # which mousewheel button is "up"
wheelbtn1=4 wheelbtn1=4

40
wmix/wmix.1x
View file

@ -40,7 +40,47 @@ Use specified mixer device instead of
\fB\-v\fR \fB\-v\fR
Verbose start, report detected channels 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 .SH FILES
.TP
.I ~/.wmixrc
User configuration file (change with option
.BR \-f )
.LP .LP
See \fI/usr/share/doc/wmix/README.gz\fP for more information See \fI/usr/share/doc/wmix/README.gz\fP for more information
. .