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 (see
  31 .SM
  32 .B "CHANNEL NAMES"
  33 below)
  34 .TP
  35 \fB\-f\fR <\fIfile\fP>
  36 Use config file instead of
  37 .I ~/.wmixrc
  38 .TP
  39 \fB\-h\fR
  40 Display list of command\-line options
  41 .TP
  42 \fB\-m\fR <\fIdevice\fP>
  43 Use specified mixer device instead of
  44 .I /dev/mixer
  45 .TP
  46 \fB\-v\fR
  47 Verbose start, report detected channels
  48 .
  49 .SH CONFIGURATION FILE
  50 If readable, the file \fI~/.wmixrc\fP (or the file specified through \fB\-f\fR option)
  51 is read on startup.
  52 It may contains one configuration command per line:
  53 .TP
  54 mousewheel=<\fI0\fP|\fI1\fP>
  55 when set to \fI0\fP, disable the volume control through mouse wheel (default=\fI1\fP)
  56 .TP
  57 osd=<\fI0\fP|\fI1\fP>
  58 when set to \fI0\fP, disable display of the volume in an OSD like fashion (default=\fI1\fP)
  59 .TP
  60 osdcolor=<\fIcolor\fP>
  61 specify the color to use for OSD volume display.
  62 It can be the name of a color (see \fI/usr/share/X11/rgb.txt\fP)
  63 or an RGB specification (as \fBrgb:\fP<\fIred\fP>/<\fIgreen\fP>/<\fIblue\fP>
  64 with hexadecimal numbers) as expected by X11 (default=\fIgreen\fP)
  65 .TP
  66 scrolltext=<\fI0\fP|\fI1\fP>
  67 when set to \fI0\fP, disable text scrolling to display the name of current selected
  68 channel, use static short name instead (default=\fI1\fP)
  69 .TP
  70 wheelbtn1=<\fIbutton\fP>
  71 .TQ
  72 wheelbtn2=<\fIbutton\fP>
  73 defines the buttons events associated in X11 to the mouse wheel,
  74 with \fIbtn1\fP for up and \fIbtn2\fP for down
  75 (default: btn1=\fI4\fP and btn2=\fI5\fP)
  76 .TP
  77 wheelstep=<\fIpercentage\fP>
  78 sets the volume change step when using the mouse wheel,
  79 specified as a percentage of the total volume range (i.e.: 1\~<\~\fIvalue\fP\~<\~100,
  80 default=\fI3\fP)
  81 .br
  82 For compatibility, values between 0.0 and 1.0 will be considered as a raw percentage
  83 .LP
  84 You may include comments in the file using the character # in which case
  85 everything will be ignored from the character to the end of the line.
  86 .
  87 .SH CHANNEL NAMES
  88 The names for the different channels are provided by ALSA/OSS as short names, for which
  89 .B wmix
  90 provides a long name match for readability.
  91 The default behavior is to scroll the long name of the current channel
  92 in the text line of the dockapp, but if you disable the scroll text
  93 then the short name will be displayed instead.
  94 .LP
  95 If you want to exclude a channel from the list of channels controlled by
  96 the dockapp you have to use the short name.
  97 You can get the list of all the channels available in your sound card with
  98 .B wmix -v
  99 and the short name will be between parentheses, here is an example:
 100 .LP
 101 .EX
 102 Supported channels:
 103   1: Master volume      (Vol  )
 104   2: PC Speaker         (Spkr )
 105   3: PCM Wave 2 volume  (Pcm2 )
 106   4: Input gain         (IGain)
 107   5: Phone output       (PhoneOut)
 108 .EE
 109 .
 110 .SH FILES
 111 .TP
 112 .I ~/.wmixrc
 113 User configuration file (change with option
 114 .BR \-f )
 115 .TP
 116 .I ~/.wmix.pid
 117 Contains process id of wmix, in case you'd need it for
 118 .IR SIGUSR1 / SIGUSR2
 119 volume control
 120 .TP
 121 .I /dev/mixer
 122 Device used for controlling volume (change with option
 123 .BR \-m )
 124 .TP
 125 .I /usr/share/doc/wmix/README
 126 More information on the user interface
 127 .
 128 .SH BUGS
 129 The \fImute\fP functionality is implemented by setting the volume to 0
 130 and remembering the previous volume to restore it when unmuting.
 131 While this is perfectly ok, you may encounter strange looking behavior
 132 if you have other application controlling the volume, and possibly
 133 implementing mute in similar ways, because there is no way to know
 134 that a channel has been muted.
 135 .LP
 136 If you modify the configuration file, do not expect \fBwmix\fP to reload
 137 it automatically, this is considered a too costly feature for such a
 138 small application.
 139 .
 140 .SH AUTHORS
 141 This man page was written by Fredrik Steen <stone@debian.org> for the Debian
 142 distribution.
 143 It was expanded by Christophe CURIS for the Window Maker Dev Team.
 144 .PP
 145 wmix was written by Tim, timecop <timecop@japan.co.jp>,
 146 with some code by Daniel Richard G. <skunk@mit.edu>