usr.sbin/mixer/mixer.8

   1 .\" Copyright (c) 1997
   2 .\"     Mike Pritchard <mpp@FreeBSD.ORG>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY MIKE PRITCHARD AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd March 14, 2008
  31 .Dt MIXER 8
  32 .Os
  33 .Sh NAME
  34 .Nm mixer
  35 .Nd set/display soundcard mixer values
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl f Ar device
  39 .Op Fl s | S
  40 .Oo
  41 .Ar dev
  42 .Sm off
  43 .Oo
  44 .Op Cm + | -
  45 .Ar lvol
  46 .Op : Oo Cm + | - Oc Ar rvol
  47 .Oc
  48 .Oc
  49 .Sm on
  50 .Ar ...
  51 .Nm
  52 .Op Fl f Ar device
  53 .Op Fl s | S
  54 .Cm recsrc
  55 .Ar ...
  56 .Nm
  57 .Op Fl f Ar device
  58 .Op Fl s | S
  59 .Sm off
  60 .Bro
  61 .Cm ^ | + | - | =
  62 .Brc
  63 .Cm rec
  64 .Sm on
  65 .Ar rdev ...
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 utility is used to set and display soundcard mixer device levels.
  70 It may
  71 also be used to start and stop recording from the soundcard.
  72 The list
  73 of mixer devices that may be modified are:
  74 .Pp
  75 .Bd -ragged -offset indent
  76 vol, bass, treble, synth, pcm, speaker, line, mic, cd, mix,
  77 pcm2, rec, igain, ogain, line1, line2, line3, dig1, dig2, dig3,
  78 phin, phout, video, radio, and monitor.
  79 .Ed
  80 .Pp
  81 Not all mixer devices are available.
  82 .Pp
  83 Without any arguments,
  84 .Nm
  85 displays the current settings for all supported devices, followed by information
  86 about the current recording input devices.
  87 If the
  88 .Ar dev
  89 argument is specified,
  90 .Nm
  91 displays only the value for that
  92 .Ar dev .
  93 .Pp
  94 To modify the mixer value
  95 .Ar dev ,
  96 the optional left and right channel settings of
  97 .Ar lvol Ns Op : Ns Ar rvol
  98 may be specified.
  99 The
 100 .Ar lvol
 101 and
 102 .Ar rvol
 103 arguments may be from 0 - 100.
 104 Omitting
 105 .Ar dev
 106 and including only the channel settings will change the main volume level.
 107 .Pp
 108 If the left or right channel settings are prefixed with
 109 .Cm +
 110 or
 111 .Cm - ,
 112 the value following will be used as a relative adjustment, modifying the
 113 current settings by the amount specified.
 114 .Pp
 115 If the
 116 .Fl s
 117 flag is used, the current mixer values will be displayed in a format suitable
 118 for use as the command-line arguments to a future invocation of
 119 .Nm
 120 (as above).
 121 .Pp
 122 The
 123 .Fl S
 124 flag provides the above output without mixing field separators.
 125 .Pp
 126 To change the recording device you use one of:
 127 .Bl -tag -width =rec -offset indent
 128 .It Cm ^rec
 129 toggles
 130 .Ar rdev
 131 of possible recording devices
 132 .It Cm +rec
 133 adds
 134 .Ar rdev
 135 to possible recording devices
 136 .It Cm -rec
 137 removes
 138 .Ar rdev
 139 from possible recording devices
 140 .It Cm =rec
 141 sets the recording device to
 142 .Ar rdev
 143 .El
 144 .Pp
 145 The above commands work on an internal mask.
 146 After all the options
 147 have been parsed, it will set then read the mask from the sound card.
 148 This will let you see EXACTLY what the soundcard is using for the
 149 recording device(s).
 150 .Pp
 151 The option recsrc will display the current recording devices.
 152 .Pp
 153 The option
 154 .Fl f
 155 .Ar device
 156 will open
 157 .Ar device
 158 as the mixer device.
 159 .Sh FILES
 160 .Bl -tag -width /dev/mixer -compact
 161 .It Pa /dev/mixer
 162 the default mixer device
 163 .El
 164 .Sh SEE ALSO
 165 .Xr cdcontrol 1
 166 .Sh HISTORY
 167 The
 168 .Nm
 169 utility first appeared in
 170 .Fx 2.0.5 .
 171 .Sh AUTHORS
 172 .An -nosplit
 173 Original source by
 174 .An Craig Metz Aq cmetz@thor.tjhsst.edu
 175 and
 176 .An Hannu Savolainen .
 177 Mostly rewritten by
 178 .An John-Mark Gurney Aq jmg@FreeBSD.org .
 179 This
 180 manual page was written by
 181 .An Mike Pritchard Aq mpp@FreeBSD.org .