Debian Codegraph @

upstream/debian-unstable/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 The color scheme file may reside in the current working directory or in the
107 .Nm
108 data directory, typically
109 .Pa /usr/share/aumix
110 or
111 .Pa /usr/share/aumix-gtk
112 if you are using the GTK-enabled
113 .Nm
114 package. This option can be used to force the ncurses interface with a GTK version.
115 No need to specify a filename in that case.
116 .It Fl d Ar device_file
117 specify the name of the mixer device (default is
118 .Pa /dev/mixer )
119 .It Fl f Ar rc_file
120 specify file for saving and loading settings
121 .It Fl h
122 display information on usage
123 .It Fl I
124 run
125 .Nm
126 interactively, using the full-screen ncurses-based interface.
127 This is the default if no options are given, but must be specified
128 in order to have
129 .Nm
130 go into interactive mode after doing things non-interactively.
131 .br
132 To force use of the ncurses interface with the GTK version,
133 specify \-C (no need to give a filename).
134 .It Fl L
135 load settings from
136 .Pa $HOME/.aumixrc ,
137 or
138 .Pa /etc/aumixrc
139 if the former is inaccessible
140 .It Fl q
141 query all devices and print their settings
142 .It Fl S
143 save settings to
144 .Pa $HOME/.aumixrc
145 .El
146 .Sh EXAMPLES
147 The command
148 .Bd -literal -offset indent
149 aumix \-q \-v75 \-m 0 \-c R \-c+10 \-m q
150 .Ed
151 .Pp
152 prints all settings, sets volume to 75%, sets microphone to 0, sets
153 CD to record, increases the CD level by ten (both left and right),
154 and prints the new settings for the microphone.
155 .Pp
156 The .aumixrc file containing:
157 .Bd -literal -offset indent
158 vol:60:60
159 wait:5000
160 vol:50:50
161 .Ed
162 .Pp
163 sets the volume to 60%, waits five seconds, then reduces the volume to 50%.
164 Note that "wait" lines will not be saved by aumix. They must be added by hand.
165 .Sh INTERACTIVE USE
166 If no options are given on the command line, and
167 .Nm
168 is compiled with ncurses, it will run interactively.
169 .Ss LAYOUT
170 The left bank of controls is used for adjusting levels; the right
171 bank is for adjusting balance.
172 Mixing channels not supported by your hardware will not be shown.
173 Mixing channels which are stereo-capable will have balance controls.
174 .Ss KEYS
175 The following keys control
176 .Nm
177 in interactive mode:
178 .Bl -tag -width Fl
179 .It page up, page down, up and down cursor
180 select a new control.
181 .It Tab, Enter, <, >, comma and period
182 toggle between level and balance controls
183 .It + , \- , \&[ , \&] , left and right cursor and digits
184 adjust the setting of the current device.
185 The
186 .Li +
187 and right cursor keys increase the level by 3%; the
188 .Li \-
189 and left cursor keys decrease it by the same amount.
190 The
191 .Li \&[
192 key sets it to 0% and
193 .Li \&]
194 or
195 .Li 0
196 set it to 100%.
197 The digits
198 .Li 1
199 to
200 .Li 9
201 set it to 10% through 90%.
202 The digit
203 .Li 0
204 sets it to 100% (not 0%).
205 The same keys work analogously on the balance controls.
206 .It Space
207 toggles between record and play for controls which are capable of
208 this.
209 .It |
210 centers the balance of the current device.
211 .It K or k
212 show a description of the functions of keys
213 .It L or l
214 load settings from
215 .Pa $HOME/.aumixrc ,
216 falling back to
217 .Pa /etc/aumixrc
218 .It M or m
219 mute or unmute
220 .It O or o
221 .Dq only :
222 mute all channels but the current one
223 .It S or s
224 save settings to the rc file
225 .It U or u
226 undo any muting
227 .It Q or q
228 end the program
229 .It ^L
230 refresh screen
231 .El
232 .Pp
233 ^Z, ^D and ^C also have their normal function (the screen is refreshed when
234 .Nm
235 is brought to the foreground).
236 .Ss MOUSE
237 In interactive mode,
238 .Nm
239 can accept input from the mouse if
240 .Xr gpm 8
241 is running and
242 .Nm
243 is compiled with
244 .Xr gpm 8
245 support.
246 If gpm is not running but gpm support is included, the message
247 .Ql mouse off
248 will appear at the top of the screen, and only keyboard input will be
249 accepted.
250 With
251 .Xr gpm 8
252 running, most functions can be performed through the mouse.
253 The mouse is active whenever one of its buttons is held down.
254 While active, it works in the following ways:
255 .Bl -bullet -compact
256 .It
257 over a control track, it sets the control to match the position of
258 the mouse cursor.
259 .It
260 over a record/play indicator, it toggles the record/play state.
261 .It
262 over the
263 .Ql Quit ,
264 .Ql Load ,
265 .Ql Save ,
266 .Ql Keys ,
267 .Ql Mute ,
268 .Ql Only ,
269 or
270 .Ql Undo
271 labels at the top of the screen, it causes those actions to take place.
272 .El
273 .Sh ENVIRONMENT
274 The
275 .Ev HOME
276 variable is used.
277 When
278 .Nm
279 is compiled with GTK+ support,
280 .Ev DISPLAY
281 is checked, and if set is used.
282 .Ev LANG
283 is used when
284 .Nm
285 the ncurses screen is displayed.
286 .Sh FILES
287 Saved settings for the mixer are kept in the
288 .Pa /etc/aumixrc
289 and
290 .Pa $HOME/.aumixrc
291 files, but can be kept anywhere if specified explicitly.
292 Color schemes are normally kept in the directory given
293 by
294 .Ev DATADIR
295 at compilation time, but are preferentially loaded
296 from the current directory and can be kept anywhere so long as the
297 path to them is specified.
298 The format of these files is:
299 .Bd -filled -offset indent
300 .Ar item
301 .Ar foreground
302 .Ar background
303 .Ed
304 .Pp
305 where
306 .Ar item
307 is one of
308 .Ql active ,
309 .Ql axis ,
310 .Ql handle ,
311 .Ql hotkey ,
312 .Ql menu ,
313 .Ql play ,
314 .Ql record ,
315 or
316 .Ql track
317 and
318 .Ar foreground
319 and
320 .Ar background
321 are one of
322 .Ql black ,
323 .Ql red ,
324 .Ql green ,
325 .Ql yellow ,
326 .Ql blue ,
327 .Ql magenta ,
328 .Ql cyan ,
329 or
330 .Ql white .
331 The words should be separated by whitespace and can be upper-,
332 lower-, or mixed-case.
333 Lines not matching all these conditions are ignored.
334 Some samples of color schemes are provided, named
335 after the sort of terminal where they should be most suitable.
336 .Pp
337 If either foreground or background is given as
338 .Ql \- ,
339 then the default color for that is used.
340 If aumix is linked against ncurses, then the terminal's
341 default fore or background will be used; else the default foreground is
342 white and the default background is black.
343 .Pp
344 An xpm icon is provided.
345 .Sh VERSION
346 This page corresponds to version 2.9.1.
347 .Sh BUGS
348 Suspending with ^Z may make the terminal difficult to use.
349 .Sh HOME PAGE
350 .Bd -literal
351 http://jpj.net/~trevor/aumix.html
352 .Ed
353 .Sh MAILING LISTS
354 .Bd -literal
355 https://gna.org/mail/?group=aumix
356 .Ed
357 .Sh SEE ALSO
358 .Xr gpm 1 ,
359 .Xr moused 8 ,
360 .Xr sb 4 ,
361 .Xr xaumix 1