usr.bin/mixerctl/mixerctl.1

   1 .\" $NetBSD: mixerctl.1,v 1.23 2008/08/15 21:10:57 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Author: Lennart Augustsson
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 .\" POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd August 15, 2008
  30 .Dt MIXERCTL 1
  31 .Os
  32 .Sh NAME
  33 .Nm mixerctl
  34 .Nd control audio mixing
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl d Ar file
  38 .Op Fl n
  39 .Op Fl v
  40 .Fl a
  41 .Nm
  42 .Op Fl d Ar file
  43 .Op Fl n
  44 .Op Fl v
  45 .Ar name ...
  46 .Nm
  47 .Op Fl d Ar file
  48 .Op Fl n
  49 .Fl w
  50 .Ar name=value ...
  51 .Nm
  52 .Op Fl d Ar file
  53 .Op Fl n
  54 .Fl w
  55 .Ar name++ ...
  56 .Nm
  57 .Op Fl d Ar file
  58 .Op Fl n
  59 .Fl w
  60 .Ar name-- ...
  61 .Nm
  62 .Op Fl d Ar file
  63 .Op Fl n
  64 .Fl w
  65 .Ar name+=value ...
  66 .Nm
  67 .Op Fl d Ar file
  68 .Op Fl n
  69 .Fl w
  70 .Ar name-=value ...
  71 .Sh DESCRIPTION
  72 The
  73 .Nm
  74 command displays or sets various audio system mixing variables.
  75 If a list of variables is present on the command line, then
  76 .Nm
  77 prints the current value of those variables for the specified device.
  78 If the
  79 .Fl a
  80 flag is specified, all variables for the device are printed.
  81 If the
  82 .Fl w
  83 flag is specified,
  84 .Nm
  85 attempts to set the specified variables to the given values.
  86 .Pp
  87 The
  88 .Fl d
  89 flag can be used to give an alternative mixer device.
  90 The default is
  91 .Pa /dev/mixer .
  92 .Pp
  93 The
  94 .Fl n
  95 flag suppresses printing of the variable name.
  96 .Pp
  97 The
  98 .Fl v
  99 flag shows the possible values of enumeration and set valued
 100 variables.
 101 Enumerated values are shown in brackets
 102 .Pq Dq []
 103 and set values are shown in curly braces
 104 .Pq Dq {} .
 105 .Pp
 106 The exact set of controls that can be manipulated depends on
 107 the mixer.
 108 The general format (in both getting and setting a value) is
 109 .br
 110 .Va "class.name" = value
 111 .br
 112 .Va class
 113 can have values like
 114 .Li inputs
 115 or
 116 .Li outputs ,
 117 indicating that the control affects the input or output
 118 of the mixer, respectively.
 119 .Va name
 120 indicates what part of the mixer the control affects.
 121 Continuous mixer values, e.g., volume, have numeric values
 122 in the range 0\-255.
 123 If
 124 .Va value
 125 can be set for each channel independently, the values are printed
 126 separated by commas.
 127 Discrete mixer values, e.g., the recording source, have symbolic names.
 128 Depending on the mixer it may either be an enumeration or a set.
 129 .Pp
 130 The suffixes ++ and -- can be used to step through the values of a
 131 mixer control.
 132 For numeric controls, these operators increase or decrease, respectively,
 133 the value by an amount (the delta) suitable to make
 134 the control assume the next possible value.
 135 For binary controls, these operators toggle between
 136 .Li on
 137 and
 138 .Li off .
 139 .Pp
 140 The operators += and -= change the value of a mixer control by the
 141 indicated number of steps.
 142 .Sh ENVIRONMENT
 143 .Bl -tag -width MIXERDEVICE
 144 .It Pa MIXERDEVICE
 145 the mixer device to use.
 146 .El
 147 .Sh FILES
 148 .Bl -tag -width /etc/mixerctl.conf -compact
 149 .It Pa /dev/mixer
 150 mixer audio device
 151 .It Pa /etc/mixerctl.conf
 152 mixer configuration file
 153 .El
 154 .Sh EXAMPLES
 155 The command
 156 .Dl "mixerctl -a -v"
 157 can produce
 158 .Bd -literal
 159 inputs.mic=0,0 volume
 160 inputs.mic.mute=off  [ off on ]
 161 inputs.cd=220,220 volume
 162 inputs.cd.mute=off  [ off on ]
 163 inputs.dac=220,220 volume
 164 inputs.dac.mute=off  [ off on ]
 165 record.record=220,220 volume
 166 record.record.source=mic  [ mic cd dac ]
 167 monitor.monitor=0 volume
 168 .Ed
 169 .Sh SEE ALSO
 170 .Xr audioctl 1 ,
 171 .Xr audio 4 ,
 172 .Xr mixerctl.conf 5 ,
 173 .Xr sysctl 8
 174 .Sh HISTORY
 175 The
 176 .Nm
 177 command first appeared in
 178 .Nx 1.3 .
 179 .Sh COMPATIBILITY
 180 The old
 181 .Fl f
 182 flag is still supported.
 183 This support will be removed eventually.