freebsd-dev/usr.sbin/mixer/mixer.8

.\" Copyright (c) 1997
.\"	Mike Pritchard <mpp@FreeBSD.ORG>.  All rights reserved.
.\"
.\" 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. Neither the name of the author 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 MIKE PRITCHARD 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd January 9, 1997
.Dt MIXER 8
.Os
.Sh NAME
.Nm mixer
.Nd set/display soundcard mixer values
.Sh SYNOPSIS
.Nm
.Op Fl f Ar device
.Oo
.Oo Ns
.Ar dev Op Ar lvol Ns Op Ar :rvol
.Li | recsrc |
.Ar {^|+|-|=}rec rdev
.Oc
.Ar ... \&
.Oc
.Sh DESCRIPTION
The
.Nm
command is used to set and display soundcard mixer device levels.
It may
also be used to start and stop recording from the soundcard.  The list
of mixer devices that may be modified are:  
.Pp
.Bd -ragged -offset indent
vol, bass, treble, synth, pcm, speaker, mic, cd, mix, 
pcm2, rec, igain, ogain, line1, line2, and line3.
.Ed
.Pp
Not all mixer devices are available.
.Pp
When
.Nm
is run without any arguments, all supported devices are displayed
along with current values.
If the
.Ar dev
argument is specified, the value for the
.Ar dev
device will be displayed.
.Pp
To modify the mixer value
.Ar dev ,
the optional left and right channel settings of
.Ar lvol Ns Op Ar :rvol
may be specified.  The
.Ar lvol
and 
.Ar rvol
arguments may be from 0 - 100.
.Pp
To change the recording device you use one of:
.Bl -tag -width =rec -offset indent
.It ^rec
toggles
.Ar rdev
of possible recording devices
.It +rec
adds
.Ar rdev
to possible recording devices
.It -rec
removes
.Ar rdev
from possible recording devices
.It =rec
sets the recording device to
.Ar rdev
.El
.Pp
The above commands work on an internal mask.  After all the options
have been parsed, it will set then read the mask from the sound card.
This will let you see EXACTLY what the soundcard is using for the
recording device(s).
.Pp
The option recsrc will display the current recording devices.
.Pp
The option
.Fl f
.Ar device
will open
.Ar device
as the mixer device.
This will ONLY work if the
.Fl f
option is immediately after the
.Nm
command.
.Sh FILES
.Bl -tag -width /dev/mixer -compact
.It Pa /dev/mixer
the default mixer device
.El
.Sh SEE ALSO
.Xr cdcontrol 1
.Sh HISTORY
The
.Nm
command first appeared in
.Fx 2.0.5 .
.Sh AUTHORS
Original source by
.An Craig Metz Aq cmetz@thor.tjhsst.edu
and
.An Hannu Savolainen .
Mostly rewritten by
.An John-Mark Gurney Aq jmg@FreeBSD.org .
This
manual page was written by
.An Mike Pritchard Aq mpp@FreeBSD.org .
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.\" Copyright (c) 1997`
			`.\" Mike Pritchard <mpp@FreeBSD.ORG>. All rights reserved.`
			`.\"`
			`.\" 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. Neither the name of the author 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 MIKE PRITCHARD 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 AUTHOR 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 20:12:29 +00:00			`.\"`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Dd January 9, 1997`
			`.Dt MIXER 8`
			`.Os`
			`.Sh NAME`
			`.Nm mixer`
			`.Nd set/display soundcard mixer values`
			`.Sh SYNOPSIS`
			`.Nm`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Op Fl f Ar device`
			`.Oo`
			`.Oo Ns`
			`.Ar dev Op Ar lvol Ns Op Ar :rvol`
			`.Li \| recsrc \|`
			`.Ar {^\|+\|-\|=}rec rdev`
			`.Oc`
			`.Ar ... \&`
			`.Oc`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`command is used to set and display soundcard mixer device levels.`
			`It may`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`also be used to start and stop recording from the soundcard. The list`
			`of mixer devices that may be modified are:`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Pp`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Bd -ragged -offset indent`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`vol, bass, treble, synth, pcm, speaker, mic, cd, mix,`
			`pcm2, rec, igain, ogain, line1, line2, and line3.`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ed`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Pp`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`Not all mixer devices are available.`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Pp`
			`When`
			`.Nm`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`is run without any arguments, all supported devices are displayed`
			`along with current values.`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`If the`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ar dev`
			`argument is specified, the value for the`
			`.Ar dev`
			`device will be displayed.`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Pp`
			`To modify the mixer value`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ar dev ,`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`the optional left and right channel settings of`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ar lvol Ns Op Ar :rvol`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`may be specified. The`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ar lvol`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`and`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`.Ar rvol`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`arguments may be from 0 - 100.`
			`.Pp`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`To change the recording device you use one of:`
			`.Bl -tag -width =rec -offset indent`
			`.It ^rec`
			`toggles`
			`.Ar rdev`
			`of possible recording devices`
			`.It +rec`
			`adds`
			`.Ar rdev`
			`to possible recording devices`
			`.It -rec`
			`removes`
			`.Ar rdev`
			`from possible recording devices`
			`.It =rec`
			`sets the recording device to`
			`.Ar rdev`
			`.El`
			`.Pp`
			`The above commands work on an internal mask. After all the options`
			`have been parsed, it will set then read the mask from the sound card.`
			`This will let you see EXACTLY what the soundcard is using for the`
			`recording device(s).`
			`.Pp`
			`The option recsrc will display the current recording devices.`
			`.Pp`
			`The option`
			`.Fl f`
			`.Ar device`
			`will open`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Ar device`
major modifications to the mixer. currently it doesn't report errors that it encounters (such as invalid device), but does print usage upon this error... but otherwise allows complex commands such as: mixer -f /dev/mixer4 synth line 50 -rec mic +rec line =rec cd ^rec mix 1997-09-19 13:38:51 +00:00			`as the mixer device.`
			`This will ONLY work if the`
			`.Fl f`
			`option is immediately after the`
			`.Nm`
			`command.`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Sh FILES`
			`.Bl -tag -width /dev/mixer -compact`
			`.It Pa /dev/mixer`
Terminate .Bl with .El 1999-11-27 16:55:50 +00:00			`the default mixer device`
			`.El`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Sh SEE ALSO`
Remove xrefs to obosolete cdplay(1) PR: docs/17079 Submitted by: Udo Erdelhoff <ue@nathan.ruhr.de> 2000-03-01 10:41:13 +00:00			`.Xr cdcontrol 1`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command first appeared in`
			`.Fx 2.0.5 .`
			`.Sh AUTHORS`
Use err(3). 1997-09-29 06:38:49 +00:00			`Original source by`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.An Craig Metz Aq cmetz@thor.tjhsst.edu`
Use err(3). 1997-09-29 06:38:49 +00:00			`and`
			`.An Hannu Savolainen .`
Spelling fix. PR: bin/14588 Submitted by: Christian Weisgerber <naddy@mips.rhein-neckar.de> 1999-10-30 19:36:42 +00:00			`Mostly rewritten by`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.An John-Mark Gurney Aq jmg@FreeBSD.org .`
Add a man page for mixer(8). 1997-01-10 06:33:13 +00:00			`This`
Use err(3). 1997-09-29 06:38:49 +00:00			`manual page was written by`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.An Mike Pritchard Aq mpp@FreeBSD.org .`