.\" from mdoc.samples(7)
.\"
.\" The following requests are required for all man pages.
.\"           .Dd Month day, year
.\"           .Os OPERATING_SYSTEM [version/release]
.\"           .Dt DOCUMENT_TITLE [section number] [volume]
.\"           .Sh NAME
.\"           .Nm name
.\"           .Nd one line description of name
.\"           .Sh SYNOPSIS
.\"           .Sh DESCRIPTION
.\" The following requests should be uncommented and
.\" used where appropriate.  This next request is
.\" for sections 2, 3 and 9 function return values only.
.\" .Sh RETURN VALUES
.\" This next request is for sections 1, 6, 7, 8 & 9 only
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" This next request is for sections 1, 6, 7, 8 & 9 only
.\"     (command return values (to shell) and
.\"       fprintf/stderr type diagnostics)
.\" .Sh DIAGNOSTICS
.\" The next request is for sections 2, 3 and 9 error
.\" and signal handling only.
.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh BUGS

.Dd December 25, 1999
.Fx on
.Ox on
.Os FreeBSD/Linux
.Dt AUMIX 1
.Sh NAME
.Nm aumix, xaumix
.Nd adjust audio mixer
.Sh SYNOPSIS
.Nm
.B aumix
[\-<channel option>[[+|-][<amount>]]|[ ]<level>|R[ecord]|P[lay]|q[uery]]
[-d] [-f <rc file>][-C <color scheme file>][-h] [-I] [-L] [-q] [-S]

.Sh DESCRIPTION
This program adjusts the settings of an audio mixing device.  It can be used from the command line, in scripts, or interactively with the keyboard or mouse.  The
.Nm xaumix
script uses the
.Nm which
utility to find an terminal emulator for X (xterm, for example), and runs
.Nm aumix
in that.

.Sh OPTIONS
.Ss CHANNEL OPTIONS
.Bl -tag -width Op
.It Fl v
main volume
.It Fl b
bass
.It Fl t
treble
.It Fl s
synthesizer
.It Fl w
PCM
.It Fl p
PC speaker
.It Fl l
line
.It Fl m
microphone
.It Fl c
CD
.It Fl x
imix
.It Fl i
line in
.It Fl o
line out
.It Fl 1
line 1
.It Fl 2
line 2
.It Fl 3
line 3
.El

For each channel, 
.Em q
queries, 
.Em +
and
.Em \-
increment and decrement by one, or an amount if one is specified.  If no
.Em +
or
.Em \-
is given after the channel option, a number sets a specific level (monophonically).

.Ss OTHER OPTIONS
.Bl -tag -width Op
.It Fl C Ar color scheme file
specify the name of a file containing a color scheme.  This implies -I.
.It Fl d Ar device file
specify the name of the mixer device (default is /dev/mixer)
.It Fl f Ar rc file
specify file for saving and loading settings
.It Fl h
display information on usage
.It Fl I
run
.Nm
interactively, using the full-screen ncurses-based interface.  This is the default if no options are given, but must be specified in order to have
.Nm
go into interactive mode after doing things non-interactively.
.It Fl L
load settings from $HOME/.aumixrc, or /etc/aumixrc if the former is inaccessible
.It Fl q
query all devices and print their settings
.It Fl S
save settings to $HOME/.aumixrc
.El

.Sh EXAMPLE
.Tp
aumix -q -v75 -m 0 -c R -c+10 -m q

prints all settings, sets volume to 75%, sets microphone to 0, sets CD to record, increases the CD level by ten (both left and right), and prints the new settings for the microphone.

.Sh INTERACTIVE USE
If no options are given on the command line, and
.Nm
is compiled with ncurses, it will run interactively.
.Ss LAYOUT
The left bank of controls is used for adjusting levels; the right bank is for adjusting balance.  Mixing channels not supported by your hardware will not be shown.  Mixing channels which are stereo-capable will have balance controls.
.Ss KEYS
The following keys control
.Nm
in interactive mode:
.Bl -tag -width Op
.It Em page up, page down, up and down cursor
select a new control.
.It Em Tab, Enter, <, >, comma and period
toggle between level and balance controls
.El

.Em + No , Em - No , Em \&[
,
.Em \&] No , Em left and right cursor
.No and Em digits
adjust the setting of the current device.  The
.Em + No and Em right cursor
keys increase the level by 3%; the
.Em \-
and
.Em left cursor
keys decrease it by the same amount.  The
.Em [
key sets it to 0% and
.Em ]
sets it to 100%.  The digits
.Em 1
to
.Em 9
set it to 10% through 90%.  The same keys work analogously on the balance controls.
.Bl -tag -width Op
.It Em Space
toggles between record and play for controls which are capable of 
this.
.It Em | centers the balance of the current device.
.It Em K No or Em k
show a description of the functions of keys
.It Em L No or Em l
load settings from $HOME/.aumixrc, falling back to /etc/aumixrc
.It Em M No or Em m
mute or unmute
.It Em O No or Em o
(\&"only\&"):  mute all channels but the current one
.It Em S No or Em s
save settings to the rc file
.It Em U No or Em u
undo any muting
.It Em Q , No or Em q
end the program
.It Em ^L
refresh screen
.El

.Em ^Z,
.Em ^D
and
.Em ^C
also have their normal function (the screen is refreshed when
.Nm
is brought to the foreground).

.Ss MOUSE
In interactive mode,
.Nm
can accept input from the mouse if
.B gpm
is running and
.Nm
is compiled with
.B gpm
support.  If gpm is not running but gpm support is included, the message
.Em mouse off
will appear at the top of the screen, and only keyboard input will be
accepted.  With
.B gpm
running, most functions can be performed through the mouse.  The mouse is
active whenever one of its buttons is held down.  While active, it works
in the following ways:
.Bl -bullet -compact
.It
over a control track, it sets the control to match the position of the mouse cursor.
.It
over a record/play indicator, it toggles the record/play state.
.It
over the 
.Em Q
in 
.Em Quit ,
the
.Em L
in
.Em Load ,
the
.Em S
in
.Em Save ,
the
.Em K
in
.Em Keys ,
the
.Em M
in
.Em Mute ,
the
.Em O
in
.Em Only ,
or the
.Em U
in
.Em Undo
at the top of the screen, it causes those actions to take place.
.El
.Sh ENVIRONMENT
The
.Ev HOME
and (when compiled with GTK+ support)
.Ev DISPLAY
variables are used.
.Sh FILES
Saved settings for the mixer are kept in the /etc/aumixrc and $HOME/.aumixrc files, but can be kept anywhere if specified explicitly.  Color schemes are normally kept in the directory given by DATADIRNAME at compilation time, but are preferentially loaded from the current directory and can be kept anywhere so long as the path to them is specified.  The format of these files is:

	item foreground background
 
where item is one of "active", "axis", "handle", "hotkey", "menu", "play", "record", or "track" and foreground and background are one of "black", "red", "green", "yellow", "blue", "magenta", "cyan", or "white".  The words should be separated by whitespace and can be upper-, lower-, or mixed-case.  Lines not matching all these conditions are ignored.  Some samples of color schemes are provided, named after the sort of terminal where they should be most suitable.

If either foreground or background is given as "-", then the default color
for that is used. If aumix is linked against ncurses, then the terminal's
default fore or background will be used; else the default foreground is
white and the default background is black.

Two xpm icons are provided.
.Sh VERSION
This page corresponds to version 2. 
.Sh BUGS
Suspending with control-Z may make the terminal difficult to use.

Please send bug reports and other correspondence to the mailing list,
aumix\@linuxatlax\.org.  Past messages may be read at
.Em http\://www\.linuxatlax\.org/archives/private/aumix/
and you may wish to join the list via
.Em http://linuxatlax.org/lists/aumix/
or by sending a message with just "subscribe" in the body to
aumix\-request@linuxatlax.org.

Information such as the version of aumix, the architecture and
operating system,and the model of sound hardware is sometimes needed
to diagnose problems, so it is best if you include such details in
any bug reports.
  
.Sh SEE ALSO

.Xr gpm 1 ,
.Xr sysmouse 4 ,
.Xr sb 4