Return to audioctl.1 CVS log

Up to [local] / src / usr.bin / audioctl

Annotation of src/usr.bin/audioctl/audioctl.1, Revision 1.20

1.20    ! jmc         1: .\" $OpenBSD: audioctl.1,v 1.19 2004/07/30 11:48:58 jmc Exp $
1.4       provos      2: .\" $NetBSD: audioctl.1,v 1.7 1998/04/27 16:55:23 augustss Exp $
1.1       provos      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: .\" 3. All advertising materials mentioning features or use of this software
                     17: .\"    must display the following acknowledgement:
                     18: .\"        This product includes software developed by the NetBSD
                     19: .\"        Foundation, Inc. and its contributors.
                     20: .\" 4. Neither the name of The NetBSD Foundation nor the names of its
                     21: .\"    contributors may be used to endorse or promote products derived
                     22: .\"    from this software without specific prior written permission.
                     23: .\"
                     24: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
                     25: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
                     26: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
1.7       aaron      27: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
1.1       provos     28: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
                     29: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
                     30: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                     31: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                     32: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
                     33: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
                     34: .\" POSSIBILITY OF SUCH DAMAGE.
                     35: .\"
1.20    ! jmc        36: .Dd $Mdocdate$
1.1       provos     37: .Dt AUDIOCTL 1
                     38: .Os
                     39: .Sh NAME
                     40: .Nm audioctl
                     41: .Nd control audio device
                     42: .Sh SYNOPSIS
1.6       aaron      43: .Nm audioctl
1.14      pvalchev   44: .Op Fl f Ar file
1.11      aaron      45: .Op Fl n
1.1       provos     46: .Fl a
1.6       aaron      47: .Nm audioctl
1.14      pvalchev   48: .Op Fl f Ar file
1.11      aaron      49: .Op Fl n
1.5       aaron      50: .Ar name
                     51: .Op Ar ...
1.6       aaron      52: .Nm audioctl
1.14      pvalchev   53: .Op Fl f Ar file
1.11      aaron      54: .Op Fl n
1.19      jmc        55: .Ar name Ns = Ns Ar value
1.5       aaron      56: .Op Ar ...
1.1       provos     57: .Sh DESCRIPTION
1.7       aaron      58: The
1.1       provos     59: .Nm
                     60: command displays or sets various audio system driver variables.
1.5       aaron      61: If a list of variables is present on the command line,
1.1       provos     62: .Nm
                     63: prints the current value of those variables for the specified device.
1.8       aaron      64: By default,
1.1       provos     65: .Nm
1.8       aaron      66: operates on the
                     67: .Pa /dev/audioctl
                     68: device.
1.1       provos     69: .Pp
1.8       aaron      70: The options are as follows:
1.19      jmc        71: .Bl -tag -width "name=valueXX"
1.8       aaron      72: .It Fl a
                     73: Print all device variables and their current values.
1.19      jmc        74: .It Fl f Ar file
                     75: Specify an alternative audio control device.
                     76: .It Fl n
                     77: Suppress printing of the variable name.
                     78: .It Ar name Ns = Ns Ar value
1.8       aaron      79: Attempt to set the specified variable
                     80: .Ar name
                     81: to
                     82: .Ar value .
                     83: .El
1.15      jmc        84: .Sh ENVIRONMENT
                     85: .Bl -tag -width AUDIOCTLDEVICE
                     86: .It Ev AUDIOCTLDEVICE
                     87: Audio control device to use.
                     88: .El
                     89: .Sh FILES
                     90: .Bl -tag -width /dev/audioctl
                     91: .It Pa /dev/audioctl
                     92: default audio control device
                     93: .El
1.1       provos     94: .Sh EXAMPLES
1.19      jmc        95: To set the playing sampling rate to 11025 you can enter:
1.8       aaron      96: .Pp
1.18      vincent    97: .Dl $ audioctl play.sample_rate=11025
1.8       aaron      98: .Pp
1.1       provos     99: Note that many of the variables that can be inspected and changed
1.17      beck      100: are reset when the
                    101: .Pa /dev/audio
                    102: device is opened.
1.8       aaron     103: This can be circumvented like so:
                    104: .Pp
1.19      jmc       105: .Dl $ (cat file.au; audioctl -f /dev/audioctl -a) \*(Gt /dev/audio
1.1       provos    106: or
1.16      jmc       107: .Bd -literal -offset indent -compact
1.18      vincent   108: $ (audioctl -f /dev/audioctl blocksize=1024; cat file.au) \e
1.19      jmc       109:        \*(Gt /dev/audio
1.16      jmc       110: .Ed
1.1       provos    111: .Sh SEE ALSO
1.19      jmc       112: .Xr aucat 1 ,
                    113: .Xr cdio 1 ,
1.1       provos    114: .Xr mixerctl 1 ,
                    115: .Xr audio 4 ,
                    116: .Xr sysctl 8
                    117: .Sh HISTORY
                    118: The
                    119: .Nm
                    120: command first appeared in
                    121: .Nx 1.3 .