Imported Upstream version 1.0.28
[platform/upstream/alsa-utils.git] / amixer / amixer.1
1 .TH AMIXER 1 "11 Aug 2000"
2 .SH NAME
3 amixer \- command-line mixer for ALSA soundcard driver
4 .SH SYNOPSIS
5 \fBamixer\fP [\fI\-option\fP] [\fIcmd\fP]
6 .SH DESCRIPTION
7 \fBamixer\fP allows command\-line control of the mixer for the ALSA
8 soundcard driver.
9 \fBamixer\fP supports multiple soundcards.
10
11 \fBamixer\fR with no arguments will display the current mixer settings
12 for the default soundcard and device. This is a good way to see a list
13 of the simple mixer controls you can use.
14
15 .SH COMMANDS
16
17 .TP
18 \fIhelp\fP
19 Shows syntax.
20
21 .TP
22 \fIinfo\fP
23 Shows the information about a mixer device.
24
25 .TP
26 \fIscontrols\fP
27 Shows a complete list of simple mixer controls.
28
29 .TP
30 \fIscontents\fP
31 Shows a complete list of simple mixer controls with their contents.
32
33 .TP
34 \fIset\fP or \fIsset\fP <\fISCONTROL\fP> <\fIPARAMETER\fP> ...
35 Sets the simple mixer control contents. The parameter can be the volume
36 either as a percentage from 0% to 100% with \fI%\fP suffix,
37 a dB gain with \fIdB\fP suffix (like \-12.5dB), or an exact hardware value.
38 The dB gain can be used only for the mixer elements with available
39 dB information.
40 When plus(+) or minus(\-) letter is appended after
41 volume value, the volume is incremented or decremented from the current
42 value, respectively.
43
44 The parameters \fIcap, nocap, mute, unmute, toggle\fP are used to
45 change capture (recording) and muting for the group specified.
46
47 The optional modifiers can be put as extra parameters to specify
48 the stream direction or channels to apply.
49 The modifiers \fIplayback\fP and \fIcapture\fP specify the stream,
50 and the modifiers \fIfront, rear, center, woofer\fP are used to specify
51 channels to be changed. 
52
53 A simple mixer control must be specified. Only one device can be controlled
54 at a time.
55
56 .TP
57 \fIget\fP or \fIsget\fP <\fISCONTROL\fP>
58 Shows the simple mixer control contents.
59
60 A simple mixer control must be specified. Only one device can be controlled
61 at a time.
62
63 .TP
64 \fIcontrols\fP
65 Shows a complete list of card controls.
66
67 .TP
68 \fIcontents\fP
69 Shows a complete list of card controls with their contents.
70
71 .TP
72 \fIcset\fP <\fICONTROL\fP> <\fIPARAMETER\fP> ...
73 Sets the card control contents. The identifier has these components: iface,
74 name, index, device, subdevice, numid. The next argument specifies the value
75 of control.
76
77 .TP
78 \fIcget\fP <\fICONTROL\fP>
79 Shows the card control contents. The identifier has same syntax as for
80 the \fIcset\fP command.
81
82 .SH OPTIONS
83
84 .TP
85 \fI\-c\fP card
86
87 Select the card number to control. The device name created from this
88 parameter has syntax 'hw:N' where N is specified card number.
89
90 .TP
91 \fI\-D\fP device
92
93 Select the device name to control. The default control name is 'default'.
94
95 .TP
96 \fI\-s\fP | \fI\-\-stdin\fP
97
98 Read from stdin and execute the command on each line sequentially.
99 When this option is given, the command in command\-line arguments is ignored.
100
101 Only sset and cset are accepted.  Other commands are ignored.
102 The commands to unmatched ids are ignored without errors too.
103
104 .TP
105 \fI\-h\fP 
106 Help: show syntax.
107
108 .TP
109 \fI\-q\fP
110 Quiet mode. Do not show results of changes.
111
112 .TP
113 \fI\-R\fP 
114 Use the raw value for evaluating the percentage representation.
115 This is the default mode.
116
117 .TP
118 \fI\-M\fP 
119 Use the mapped volume for evaluating the percentage representation
120 like \fBalsamixer\fR, to be more natural for human ear.
121
122 .SH EXAMPLES
123
124 .TP
125 \fBamixer \-c 1 sset Line,0 80%,40% unmute cap\fR
126 will set the second soundcard's left line input volume to 80% and
127 right line input to 40%, unmute it, and select it as a source for
128 capture (recording).\fR
129
130 .TP
131 \fBamixer \-c 1 \-\- sset Master playback \-20dB\fR
132 will set the master volume of the second card to \-20dB.  If the master
133 has multiple channels, all channels are set to the same value.
134
135 .TP
136 \fBamixer \-c 1 set PCM 2dB+\fR
137 will increase the PCM volume of the second card with 2dB.  When both
138 playback and capture volumes exist, this is applied to both volumes.
139
140 .TP
141 \fBamixer \-c 2 cset iface=MIXER,name='Line Playback Volume",index=1 40%\fR
142 will set the third soundcard's second line playback volume(s) to 40%
143
144 .TP
145 \fBamixer \-c 2 cset numid=34 40%\fR
146 will set the 34th soundcard element to 40%
147
148 .SH SEE ALSO
149 \fB
150 alsamixer(1)
151 \fP
152
153 .SH BUGS 
154 None known.
155
156 .SH AUTHOR
157 \fBamixer\fP is by Jaroslav Kysela <perex@perex.cz>.
158 This document is by Paul Winkler <zarmzarm@erols.com> and Jaroslav Kysela <perex@perex.cz>.