[BACK]Return to mixerctl.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / mixerctl

Annotation of src/usr.bin/mixerctl/mixerctl.1, Revision 1.23

1.23    ! deraadt     1: .\" $OpenBSD: mixerctl.1,v 1.22 2004/11/22 09:26:24 jsg Exp $
1.6       provos      2: .\" $NetBSD: mixerctl.1,v 1.8 1998/05/09 12:41:16 augustss Exp $
1.5       millert     3: .\"
1.1       provos      4: .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
                      5: .\" All rights reserved.
                      6: .\"
                      7: .\" Author: Lennart Augustsson
                      8: .\"
                      9: .\" Redistribution and use in source and binary forms, with or without
                     10: .\" modification, are permitted provided that the following conditions
                     11: .\" are met:
                     12: .\" 1. Redistributions of source code must retain the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer.
                     14: .\" 2. Redistributions in binary form must reproduce the above copyright
                     15: .\"    notice, this list of conditions and the following disclaimer in the
                     16: .\"    documentation and/or other materials provided with the distribution.
                     17: .\" 3. All advertising materials mentioning features or use of this software
                     18: .\"    must display the following acknowledgement:
                     19: .\"        This product includes software developed by the NetBSD
                     20: .\"        Foundation, Inc. and its contributors.
                     21: .\" 4. Neither the name of The NetBSD Foundation nor the names of its
                     22: .\"    contributors may be used to endorse or promote products derived
                     23: .\"    from this software without specific prior written permission.
                     24: .\"
                     25: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
                     26: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
                     27: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
1.6       provos     28: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
1.1       provos     29: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
                     30: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
                     31: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                     32: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                     33: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
                     34: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
                     35: .\" POSSIBILITY OF SUCH DAMAGE.
                     36: .\"
                     37: .Dd May 4, 1997
                     38: .Dt MIXERCTL 1
                     39: .Os
                     40: .Sh NAME
                     41: .Nm mixerctl
                     42: .Nd control audio mixing
                     43: .Sh SYNOPSIS
1.9       aaron      44: .Nm mixerctl
1.19      jmc        45: .Op Fl nv
1.1       provos     46: .Op Fl f Ar file
                     47: .Fl a
1.9       aaron      48: .Nm mixerctl
1.19      jmc        49: .Op Fl nv
1.1       provos     50: .Op Fl f Ar file
1.8       aaron      51: .Ar name Op Ar ...
1.9       aaron      52: .Nm mixerctl
1.23    ! deraadt    53: .Op Fl qt
        !            54: .Op Fl f Ar file
        !            55: .Ar name Op Ar ...
        !            56: .Nm mixerctl
1.17      jfb        57: .Op Fl q
1.19      jmc        58: .Pf \ \& Op Fl f Ar file
                     59: .Xo
                     60: .Ar name Ns = Ns Ar value
                     61: .Op Ar ...
                     62: .Xc
1.1       provos     63: .Sh DESCRIPTION
1.6       provos     64: The
1.1       provos     65: .Nm
                     66: command displays or sets various audio system mixing variables.
1.10      aaron      67: If a list of variables is present on the command line,
1.1       provos     68: .Nm
                     69: prints the current value of those variables for the specified device.
1.10      aaron      70: By default,
1.1       provos     71: .Nm
1.10      aaron      72: operates on the
                     73: .Pa /dev/mixer
                     74: device.
                     75: .Pp
                     76: The options are as follows:
1.19      jmc        77: .Bl -tag -width "-f file"
1.10      aaron      78: .It Fl a
                     79: Print all device variables and their current values.
1.15      pvalchev   80: .It Fl f Ar file
                     81: Specify an alternative audio mixing device.
                     82: .It Fl n
                     83: Suppress printing of the variable name.
1.17      jfb        84: .It Fl q
                     85: Suppress all printing when setting a variable.
1.23    ! deraadt    86: .It Fl t
        !            87: Attempt to select the next possible enumeration value.
1.10      aaron      88: .It Fl v
                     89: Show the possible values of enumeration and set valued variables.
                     90: Enumerated values are shown in
                     91: .Dq []
                     92: and set values are shown in
                     93: .Dq {} .
1.20      tedu       94: .It Ar name Ns = Ns Ar value
1.19      jmc        95: Attempt to set the specified variable
1.15      pvalchev   96: .Ar name
                     97: to
                     98: .Ar value .
1.10      aaron      99: .El
1.5       millert   100: .Pp
                    101: Values may be specified in either absolute or relative forms.
                    102: The relative form is indicated by a prefix of
1.10      aaron     103: .Ql +
1.5       millert   104: or
1.10      aaron     105: .Ql -
                    106: to denote an increase or decrease, respectively.
1.1       provos    107: .Pp
1.10      aaron     108: The exact set of controls that can be manipulated depends on
                    109: the mixer.
                    110: The general format (in both getting and setting a value) is
1.1       provos    111: .Pp
1.19      jmc       112: .D1 class.name=value
1.6       provos    113: .Pp
                    114: The
1.19      jmc       115: .Ar class
1.6       provos    116: can have values like
                    117: .Li inputs
                    118: or
                    119: .Li outputs
1.19      jmc       120: indicating that the control affects the input or output, respectively,
                    121: to the mixer.
1.10      aaron     122: The
1.19      jmc       123: .Ar name
1.6       provos    124: indicates what part of the mixer the control affects.
1.8       aaron     125: Continuous mixer values, e.g., volume, have numeric values
1.10      aaron     126: in the range 0-255.
1.19      jmc       127: If
                    128: .Ar value
                    129: can be set for each channel independently,
1.10      aaron     130: the values are printed separated by commas.
                    131: Discrete mixer values, e.g.,
                    132: the recording source, have symbolic names.
                    133: Depending on the mixer it
1.6       provos    134: may either be an enumeration or a set.
1.18      jmc       135: .Sh ENVIRONMENT
                    136: .Bl -tag -width MIXERDEVICE
                    137: .It Ev MIXERDEVICE
                    138: The audio mixer device to use.
                    139: .El
                    140: .Sh FILES
                    141: .Bl -tag -width /dev/mixer
                    142: .It Pa /dev/mixer
                    143: default mixer audio device
                    144: .El
1.6       provos    145: .Sh EXAMPLES
1.7       deraadt   146: The command
1.10      aaron     147: .Pp
1.14      deraadt   148: .Dl "$ mixerctl -a -v"
1.10      aaron     149: .Pp
1.6       provos    150: can produce
1.19      jmc       151: .Bd -literal -offset indent
1.6       provos    152: inputs.mic=0,0 volume
                    153: inputs.mic.mute=off  [ off on ]
                    154: inputs.cd=220,220 volume
                    155: inputs.cd.mute=off  [ off on ]
                    156: inputs.dac=220,220 volume
                    157: inputs.dac.mute=off  [ off on ]
                    158: record.record=220,220 volume
                    159: record.record.source=mic  [ mic cd dac ]
                    160: monitor.monitor=0 volume
1.23    ! deraadt   161: .Ed
        !           162: .Pp
        !           163: The command to toggle
        !           164: .Dq inputs.dac.mute
        !           165: .Pp
        !           166: .Dl "$ mixerctl -t inputs.dac.mute"
        !           167: .Pp
        !           168: produces
        !           169: .Bd -literal -offset indent
        !           170: inputs.dac.mute: off -> on
1.6       provos    171: .Ed
1.1       provos    172: .Sh SEE ALSO
1.21      jmc       173: .Xr aucat 1 ,
1.1       provos    174: .Xr audioctl 1 ,
1.21      jmc       175: .Xr cdio 1 ,
1.1       provos    176: .Xr audio 4 ,
1.22      jsg       177: .Xr mixerctl.conf 5 ,
1.1       provos    178: .Xr sysctl 8
                    179: .Sh HISTORY
                    180: The
                    181: .Nm
                    182: command first appeared in
                    183: .Nx 1.3 .