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