wmix/wmix.1x

   1 .TH wmix 1x "2.2" "Fredrik Steen"
   2 .SH NAME
   3 wmix \- Dockapp mixer for OSS or ALSA
   4 .
   5 .SH SYNOPSIS
   6 .B wmix
   7 .RI [ options... ]
   8 .br
   9 .B wmix
  10 .I \-h
  11 .
  12 .SH DESCRIPTION
  13 Docked application to control audio mixer for OSS or ALSA.
  14 Allows toggling record source,
  15 muting individual channels, adjusting volume and balance, all in a
  16 compact dockapp size, with TV\-like on\-screen\-display for volume levels.
  17 .LP
  18 Supports mouse wheel to adjust current channel's volume
  19 and can be controlled remotely with unix signals
  20 .IR SIGUSR1 / SIGUSR2
  21 to raise/lower the volume.
  22 Keeps a simple configuration file for user\-defined settings.
  23 .
  24 .SH OPTIONS
  25 .TP
  26 \fB\-d\fR <\fIdisplay\fP>
  27 Connect to remote X display
  28 .TP
  29 \fB\-e\fR <\fIname\fP>
  30 Exclude channel from control
  31 .TP
  32 \fB\-f\fR <\fIfile\fP>
  33 Use config file instead of
  34 .I ~/.wmixrc
  35 .TP
  36 \fB\-h\fR
  37 Display list of command\-line options
  38 .TP
  39 \fB\-m\fR <\fIdevice\fP>
  40 Use specified mixer device instead of
  41 .I /dev/mixer
  42 .TP
  43 \fB\-v\fR
  44 Verbose start, report detected channels
  45 .
  46 .SH CONFIGURATION FILE
  47 If readable, the file \fI~/.wmixrc\fP (or the file specified through \fB\-f\fR option)
  48 is read on startup.
  49 It may contains one configuration command per line:
  50 .TP
  51 mousewheel=<\fI0\fP|\fI1\fP>
  52 when set to \fI0\fP, disable the volume control through mouse wheel (default=\fI1\fP)
  53 .TP
  54 osd=<\fI0\fP|\fI1\fP>
  55 when set to \fI0\fP, disable display of the volume in an OSD like fashion (default=\fI1\fP)
  56 .TP
  57 osdcolor=<\fIcolor\fP>
  58 specify the color to use for OSD volume display.
  59 It can be the name of a color (see \fI/usr/share/X11/rgb.txt\fP)
  60 or an RGB specification (as \fBrgb:\fP<\fIred\fP>/<\fIgreen\fP>/<\fIblue\fP>
  61 with hexadecimal numbers) as expected by X11 (default=\fIgreen\fP)
  62 .TP
  63 scrolltext=<\fI0\fP|\fI1\fP>
  64 when set to \fI0\fP, disable text scrolling to display the name of current selected
  65 channel, use static short name instead (default=\fI1\fP)
  66 .TP
  67 wheelbtn1=<\fIbutton\fP>
  68 .TQ
  69 wheelbtn2=<\fIbutton\fP>
  70 defines the buttons events associated in X11 to the mouse wheel,
  71 with \fIbtn1\fP for up and \fIbtn2\fP for down
  72 (default: btn1=\fI4\fP and btn2=\fI5\fP)
  73 .TP
  74 wheelstep=<\fIpercentage\fP>
  75 sets the volume change step when using the mouse wheel,
  76 specified as a percentage of the total volume range (i.e.: 1\~<\~\fIvalue\fP\~<\~100,
  77 default=\fI3\fP)
  78 .br
  79 For compatibility, values between 0.0 and 1.0 will be considered as a raw percentage
  80 .LP
  81 .
  82 .SH FILES
  83 .TP
  84 .I ~/.wmixrc
  85 User configuration file (change with option
  86 .BR \-f )
  87 .TP
  88 .I ~/.wmix.pid
  89 Contains process id of wmix, in case you'd need it for
  90 .IR SIGUSR1 / SIGUSR2
  91 volume control
  92 .TP
  93 .I /dev/mixer
  94 Device used for controlling volume (change with option
  95 .BR \-m )
  96 .TP
  97 .I /usr/share/doc/wmix/README
  98 More information on the user interface
  99 .
 100 .SH BUGS
 101 The \fImute\fP functionality is implemented by setting the volume to 0
 102 and remembering the previous volume to restore it when unmuting.
 103 While this is perfectly ok, you may encounter strange looking behavior
 104 if you have other application controlling the volume, and possibly
 105 implementing mute in similar ways, because there is no way to know
 106 that a channel has been muted.
 107 .LP
 108 If you modify the configuration file, do not expect \fBwmix\fP to reload
 109 it automatically, this is considered a too costly feature for such a
 110 small application.
 111 .
 112 .SH AUTHORS
 113 This man page was written by Fredrik Steen <stone@debian.org> for the Debian
 114 distribution.
 115 It was expanded by Christophe CURIS for the Window Maker Dev Team.
 116 .PP
 117 wmix was written by Tim, timecop <timecop@japan.co.jp>,
 118 with some code by Daniel Richard G. <skunk@mit.edu>