cnslock: Complete rewrite using libdockapp.
[dockapps.git] / wmmixer / wmmixer.1
blobfc4c90ed21f18a3a097f91608d14cfb82605dfc0
1 .TH wmmixer 1 "April 02, 2002" Debian "Windowmaker Mixer Application"
3 .SH NAME
4 wmmixer \- A mixer application designed for WindowMaker
5 .SH DESCRIPTION
6 \fBwmmixer\fP is a mixer application designed for WindowMaker, although
7 there is nothing in the program that makes it require WindowMaker, except
8 maybe the NeXTStep look and the fact that it
9 properly docks. It can be used with other window managers without problems.
10 .SH SYNOPSIS
11 .B wmmixer [options]
12 .SH OPTIONS
13 This program follows the usual GNU command line syntax, with long options
14 starting with two dashes ('\-\-'). A summary of options is included below.
15 .TP
16 .B \-d,  \-\-display <\fIstring\fP>
17 Attempt to open a window on the named X display. In the absence of  this
18 option
19 the  display  specified  by the
20 .B DISPLAY
21 environment variable is used.
22 .TP
23 .B \-g, \-\-geometry <\fIstring\fP>
24 geometry to use, e.g. +100+100 to place it at 100/100
25 .TP
26 .B \-h, \-\-help
27 show help text and exit.
28 .TP
29 .B \-v, \-\-version
30 show program version and exit.
31 .TP
32 .B \-w, \-\-withdrawn
33 run the application in withdrawn mode. This is for use with WindowMaker or
34 other window managers supporting docks (e.g. KDE)
35 .TP
36 .B \-a, \-\-afterstep
37 use smaller window (for AfterStep Wharf)
38 .TP
39 .B \-s, \-\-shaped
40 shaped window
41 .TP
42 .B \-l, \-\-led\-color <\fIstring\fP>
43 use the specified color for led, e.g. red, green, blue (default: green)
44 .TP
45 .B \-L, \-\-led\-highcolor <\fIstring\fP>
46 use the specified color for led-shading, e.g. red, green, blue (default: red)
47 .TP
48 .B \-b, \-\-back\-color <\fIstring\fP>
49 use the specified color for backgrounds, e.g. red, green, blue
50 .TP
51 .B \-m, \-\-mix\-device <\fIstring\fP>
52 use specified device (rather than /dev/mixer)
53 .TP
54 .B \-r, \-\-scrollwheel <\fInumber\fP>
55 Set the volume increase/decrease when using the mouse wheel (default: 2)
56 .TP
57 For backward compatibility the following obsolete options are still supported:
59 .TP
60 .B \-help
61 show help text and exit.
62 .TP
63 .B \-display
64 attempt to open a window on the named X display
65 .TP
66 .B \-position
67 geometry to use, e.g. +100+100 to place it at 100/100
69 .SH USAGE
70 All available channels on your soundcard's mixer are accessible with
71 \fIwmmixer\fP. Most common channels are identified with an appropriate icon.
72 Controls include a stereo (mono where appropriate) volume control and a
73 recording source toggle button.
75 Press the "<" and ">" arrow buttons to select a channel.
76 The icon identifies the current channel (a volume symbol with a question
77 mark represents an unrecognised channel).
78 Click and/or drag the volume display to set channel volume.
79 There is a also a button to set recording sources.
82 .SH CONFIGURATION
83 Users can configure wmmixer to suit their requirements by means of a
84 \fI~/.wmmixer\fP file. A commented example can be found in /usr/share/doc/wmmixer on Debian systems, and would be a good starting point
87 .SH AUTHOR
88 wmmixer was originally written by Sam Hawker <shawkie@geocities.com>,
89 and then adopted by Gordon Fraser <gordon@debian.org>.
91 This manual page was written by Gordon Fraser <gordon@debian.org>.