NetBSD/usr.bin/mixerctl/mixerctl.1

.\" $NetBSD: mixerctl.1,v 1.9 1998/08/21 19:45:38 augustss Exp $
.\" Copyright (c) 1997 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" Author: Lennart Augustsson
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 4, 1997
.Dt MIXERCTL 1
.Os
.Sh NAME
.Nm mixerctl
.Nd control audio mixing
.Sh SYNOPSIS
.Nm
.Op Fl f Ar file
.Op Fl n
.Op Fl v
.Fl a
.Nm ""
.Op Fl f Ar file
.Op Fl n
.Op Fl v
.Ar name ...
.Nm ""
.Op Fl f Ar file
.Op Fl n
.Fl w
.Ar name=value ...
.Sh DESCRIPTION
The 
.Nm
command displays or sets various audio system mixing variables.
If a list of variables is present on the command line, then
.Nm
prints the current value of those variables for the specified device.
If the 
.Fl a
flag is specified, all variables for the device are printed.
If the
.Fl w
flag is specified
.Nm
attempts to set the specified variables to the given values.
.Pp
The
.Fl f
flag can be used to give an alternative mixer device, the default is
.Pa /dev/mixer0 .
.Pp
The
.Fl n
flag suppresses printing of the variable name.
.Pp
The
.Fl v
flag shows the possible values of enumeration and set valued
variables.  Enumerated values are shown in [] and set values
are shown in {}.
.Pp
The exact set of controls that can be manipulated depends on
the mixer.  The general format (in both getting and setting a value)
is
.br
.Va "class.name" = value
.br
The
.Va class
can have values like
.Li inputs
or
.Li outputs
indicating that the control affects the input resp. output to the
mixer.  The 
.Va name
indicates what part of the mixer the control affects.
Continous mixer values, e.g., volume, have numeric values
in the range 0-255.  If value can be set for each channel independently
the values are printed separated by commas.  Discrete mixer values, e.g.,
the recording source, have symbolic names.  Depending on the mixer it
may either be an enumeration or a set.
.Sh EXAMPLES
The commmand
.Dl "mixerctl -a -v"
can produce
.Bd -literal
inputs.mic=0,0 volume
inputs.mic.mute=off  [ off on ]
inputs.cd=220,220 volume
inputs.cd.mute=off  [ off on ]
inputs.dac=220,220 volume
inputs.dac.mute=off  [ off on ]
record.record=220,220 volume
record.record.source=mic  [ mic cd dac ]
monitor.monitor=0 volume
.Ed
.Sh FILES
.Bl -tag -width /dev/mixer0
.It Pa /dev/mixer0
mixer audio device
.El
.Sh ENVIRONMENT
.Bl -tag -width MIXERDEVICE
.It Pa MIXERDEVICE
the mixer device to use.
.Sh SEE ALSO
.Xr audioctl 1 ,
.Xr audio 4 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
command first appeared in
.Nx 1.3 .