Debian Codegraph @

upstream/mageia-cauldron/man1/aumix.1

raw
1 .\" $Aumix: aumix/doc/aumix.1,v 1.7 2010/05/04 23:30:28 trevor Exp $
2 .\" from mdoc.samples(7)
3 .\"
4 .\" The following requests are required for all man pages.
5 .\" .Dd Month day, year
6 .\" .Os OPERATING_SYSTEM [version/release]
7 .\" .Dt DOCUMENT_TITLE [section number] [volume]
8 .\" .Sh NAME
9 .\" .Nm name
10 .\" .Nd one line description of name
11 .\" .Sh SYNOPSIS
12 .\" .Sh DESCRIPTION
13 .\" The following requests should be uncommented and
14 .\" used where appropriate. This next request is
15 .\" for sections 2, 3 and 9 function return values only.
16 .\" .Sh RETURN VALUES
17 .\" This next request is for sections 1, 6, 7, 8 & 9 only
18 .\" .Sh ENVIRONMENT
19 .\" .Sh FILES
20 .\" .Sh EXAMPLES
21 .\" This next request is for sections 1, 6, 7, 8 & 9 only
22 .\" (command return values (to shell) and
23 .\" fprintf/stderr type diagnostics)
24 .\" .Sh DIAGNOSTICS
25 .\" The next request is for sections 2, 3 and 9 error
26 .\" and signal handling only.
27 .\" .Sh ERRORS
28 .\" .Sh SEE ALSO
29 .\" .Sh STANDARDS
30 .\" .Sh HISTORY
31 .\" .Sh AUTHORS
32 .\" .Sh BUGS
33 .\"
34 .Dd July 13, 2000
35 .Os
36 .Dt AUMIX 1
37 .Sh NAME
38 .Nm aumix
39 .Nd adjust audio mixer
40 .Sh SYNOPSIS
41 .Nm
42 [\-<channel option>[[+|\-][<amount>]]|<level>|R[ecord]|P[lay]|q[uery]]
43 [\-dhILqS] [\-f <rc file>][\-C <color scheme file>]
44 .Sh DESCRIPTION
45 This program adjusts the settings of an audio mixing device.
46 It can be used from the command line, in scripts, or interactively
47 with the keyboard or mouse.
48 .Sh OPTIONS
49 .Ss CHANNEL OPTIONS
50 .Bl -tag -width Fl -compact
51 .It Fl v
52 main volume
53 .It Fl b
54 bass
55 .It Fl c
56 CD
57 .It Fl i
58 input gain
59 .It Fl l
60 line
61 .It Fl m
62 microphone
63 .It Fl o
64 output gain
65 .It Fl p
66 PC speaker
67 .It Fl r
68 record
69 .It Fl s
70 synthesizer
71 .It Fl t
72 treble
73 .It Fl w
74 PCM
75 .It Fl W
76 PCM 2
77 .It Fl x
78 mix monitor
79 .It Fl 1
80 line 1
81 .It Fl 2
82 line 2
83 .It Fl 3
84 line 3
85 .El
86 .Pp
87 For each channel,
88 .Cm q
89 queries,
90 .Cm +
91 and
92 .Cm \-
93 increment and decrement by one, or an amount if one is specified.
94 If no
95 .Cm +
96 or
97 .Cm \-
98 is given after the channel option, a number sets a specific level
99 (monophonically).
100 .Ss OTHER OPTIONS
101 .Bl -tag -width Fl
102 .It Fl C Ar color_scheme_file
103 specify the name of a file containing a color scheme.
104 This implies
105 .Fl I .
106 .It Fl d Ar device_file
107 specify the name of the mixer device (default is
108 .Pa /dev/mixer )
109 .It Fl f Ar rc_file
110 specify file for saving and loading settings
111 .It Fl h
112 display information on usage
113 .It Fl I
114 run
115 .Nm
116 interactively, using the full-screen ncurses-based interface.
117 This is the default if no options are given, but must be specified
118 in order to have
119 .Nm
120 go into interactive mode after doing things non-interactively.
121 .It Fl L
122 load settings from
123 .Pa $HOME/.aumixrc ,
124 or
125 .Pa /etc/aumixrc
126 if the former is inaccessible
127 .It Fl q
128 query all devices and print their settings
129 .It Fl S
130 save settings to
131 .Pa $HOME/.aumixrc
132 .El
133 .Sh EXAMPLES
134 The command
135 .Bd -literal -offset indent
136 aumix \-q \-v75 \-m 0 \-c R \-c+10 \-m q
137 .Ed
138 .Pp
139 prints all settings, sets volume to 75%, sets microphone to 0, sets
140 CD to record, increases the CD level by ten (both left and right),
141 and prints the new settings for the microphone.
142 .Pp
143 The .aumixrc file containing:
144 .Bd -literal -offset indent
145 vol:60:60
146 wait:5000
147 vol:50:50
148 .Ed
149 .Pp
150 sets the volume to 60%, waits five seconds, then reduces the volume to 50%.
151 Note that "wait" lines will not be saved by aumix. They must be added by hand.
152 .Sh INTERACTIVE USE
153 If no options are given on the command line, and
154 .Nm
155 is compiled with ncurses, it will run interactively.
156 .Ss LAYOUT
157 The left bank of controls is used for adjusting levels; the right
158 bank is for adjusting balance.
159 Mixing channels not supported by your hardware will not be shown.
160 Mixing channels which are stereo-capable will have balance controls.
161 .Ss KEYS
162 The following keys control
163 .Nm
164 in interactive mode:
165 .Bl -tag -width Fl
166 .It page up, page down, up and down cursor
167 select a new control.
168 .It Tab, Enter, <, >, comma and period
169 toggle between level and balance controls
170 .It + , \- , \&[ , \&] , left and right cursor and digits
171 adjust the setting of the current device.
172 The
173 .Li +
174 and right cursor keys increase the level by 3%; the
175 .Li \-
176 and left cursor keys decrease it by the same amount.
177 The
178 .Li \&[
179 key sets it to 0% and
180 .Li \&]
181 or
182 .Li 0
183 set it to 100%.
184 The digits
185 .Li 1
186 to
187 .Li 9
188 set it to 10% through 90%.
189 The same keys work analogously on the balance controls.
190 .It Space
191 toggles between record and play for controls which are capable of
192 this.
193 .It |
194 centers the balance of the current device.
195 .It K or k
196 show a description of the functions of keys
197 .It L or l
198 load settings from
199 .Pa $HOME/.aumixrc ,
200 falling back to
201 .Pa /etc/aumixrc
202 .It M or m
203 mute or unmute
204 .It O or o
205 .Dq only :
206 mute all channels but the current one
207 .It S or s
208 save settings to the rc file
209 .It U or u
210 undo any muting
211 .It Q or q
212 end the program
213 .It ^L
214 refresh screen
215 .El
216 .Pp
217 ^Z, ^D and ^C also have their normal function (the screen is refreshed when
218 .Nm
219 is brought to the foreground).
220 .Ss MOUSE
221 In interactive mode,
222 .Nm
223 can accept input from the mouse if
224 .Xr gpm 8
225 is running and
226 .Nm
227 is compiled with
228 .Xr gpm 8
229 support.
230 If gpm is not running but gpm support is included, the message
231 .Ql mouse off
232 will appear at the top of the screen, and only keyboard input will be
233 accepted.
234 With
235 .Xr gpm 8
236 running, most functions can be performed through the mouse.
237 The mouse is active whenever one of its buttons is held down.
238 While active, it works in the following ways:
239 .Bl -bullet -compact
240 .It
241 over a control track, it sets the control to match the position of
242 the mouse cursor.
243 .It
244 over a record/play indicator, it toggles the record/play state.
245 .It
246 over the
247 .Ql Quit ,
248 .Ql Load ,
249 .Ql Save ,
250 .Ql Keys ,
251 .Ql Mute ,
252 .Ql Only ,
253 or
254 .Ql Undo
255 labels at the top of the screen, it causes those actions to take place.
256 .El
257 .Sh ENVIRONMENT
258 The
259 .Ev HOME
260 variable is used.
261 When
262 .Nm
263 is compiled with GTK+ support,
264 .Ev DISPLAY
265 is checked, and if set is used.
266 .Ev LANG
267 is used when
268 .Nm
269 the ncurses screen is displayed.
270 .Sh FILES
271 Saved settings for the mixer are kept in the
272 .Pa /etc/aumixrc
273 and
274 .Pa $HOME/.aumixrc
275 files, but can be kept anywhere if specified explicitly.
276 Color schemes are normally kept in the directory given
277 by
278 .Ev DATADIR
279 at compilation time, but are preferentially loaded
280 from the current directory and can be kept anywhere so long as the
281 path to them is specified.
282 The format of these files is:
283 .Bd -filled -offset indent
284 .Ar item
285 .Ar foreground
286 .Ar background
287 .Ed
288 .Pp
289 where
290 .Ar item
291 is one of
292 .Ql active ,
293 .Ql axis ,
294 .Ql handle ,
295 .Ql hotkey ,
296 .Ql menu ,
297 .Ql play ,
298 .Ql record ,
299 or
300 .Ql track
301 and
302 .Ar foreground
303 and
304 .Ar background
305 are one of
306 .Ql black ,
307 .Ql red ,
308 .Ql green ,
309 .Ql yellow ,
310 .Ql blue ,
311 .Ql magenta ,
312 .Ql cyan ,
313 or
314 .Ql white .
315 The words should be separated by whitespace and can be upper-,
316 lower-, or mixed-case.
317 Lines not matching all these conditions are ignored.
318 Some samples of color schemes are provided, named
319 after the sort of terminal where they should be most suitable.
320 .Pp
321 If either foreground or background is given as
322 .Ql \- ,
323 then the default color for that is used.
324 The defaults are a white foreground and black background.
325 .Pp
326 An xpm icon is provided.
327 .Sh VERSION
328 This page corresponds to version 2.9.1.
329 .Sh BUGS
330 Suspending with ^Z may make the terminal difficult to use.
331 .Sh HOME PAGE
332 .Bd -literal
333 http://jpj.net/~trevor/aumix.html
334 .Sh MAILING LISTS
335 .Bd -literal
336 https://gna.org/mail/?group=aumix
337 .Sh SEE ALSO
338 .Xr gpm 1 ,
339 .Xr moused 8 ,
340 .Xr sb 4 ,
341 .Xr xaumix 1