Return to audioctl.1 CVS log

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

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

1.27    ! ratchov     1: .\" $OpenBSD: audioctl.1,v 1.26 2008/06/26 05:42:20 ray 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: .\"
                     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
1.7       aaron      20: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
1.1       provos     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: .\"
1.27    ! ratchov    29: .Dd $Mdocdate: June 26 2008 $
1.1       provos     30: .Dt AUDIOCTL 1
                     31: .Os
                     32: .Sh NAME
                     33: .Nm audioctl
                     34: .Nd control audio device
                     35: .Sh SYNOPSIS
1.6       aaron      36: .Nm audioctl
1.23      sobrado    37: .Op Fl an
1.14      pvalchev   38: .Op Fl f Ar file
1.6       aaron      39: .Nm audioctl
1.22      sobrado    40: .Op Fl n
1.14      pvalchev   41: .Op Fl f Ar file
1.21      sobrado    42: .Ar name ...
1.6       aaron      43: .Nm audioctl
1.22      sobrado    44: .Op Fl n
1.14      pvalchev   45: .Op Fl f Ar file
1.21      sobrado    46: .Ar name Ns = Ns Ar value ...
1.1       provos     47: .Sh DESCRIPTION
1.7       aaron      48: The
1.1       provos     49: .Nm
                     50: command displays or sets various audio system driver variables.
1.5       aaron      51: If a list of variables is present on the command line,
1.1       provos     52: .Nm
                     53: prints the current value of those variables for the specified device.
1.8       aaron      54: By default,
1.1       provos     55: .Nm
1.8       aaron      56: operates on the
                     57: .Pa /dev/audioctl
                     58: device.
1.1       provos     59: .Pp
1.8       aaron      60: The options are as follows:
1.19      jmc        61: .Bl -tag -width "name=valueXX"
1.8       aaron      62: .It Fl a
                     63: Print all device variables and their current values.
1.23      sobrado    64: This is the default, if no parameters are given to
                     65: .Nm .
1.19      jmc        66: .It Fl f Ar file
                     67: Specify an alternative audio control device.
                     68: .It Fl n
                     69: Suppress printing of the variable name.
                     70: .It Ar name Ns = Ns Ar value
1.8       aaron      71: Attempt to set the specified variable
                     72: .Ar name
                     73: to
                     74: .Ar value .
                     75: .El
1.15      jmc        76: .Sh ENVIRONMENT
                     77: .Bl -tag -width AUDIOCTLDEVICE
                     78: .It Ev AUDIOCTLDEVICE
                     79: Audio control device to use.
                     80: .El
                     81: .Sh FILES
                     82: .Bl -tag -width /dev/audioctl
                     83: .It Pa /dev/audioctl
                     84: default audio control device
                     85: .El
1.1       provos     86: .Sh EXAMPLES
1.19      jmc        87: To set the playing sampling rate to 11025 you can enter:
1.8       aaron      88: .Pp
1.27    ! ratchov    89: .Dl $ audioctl play.rate=11025
1.8       aaron      90: .Pp
1.1       provos     91: Note that many of the variables that can be inspected and changed
1.17      beck       92: are reset when the
                     93: .Pa /dev/audio
                     94: device is opened.
1.8       aaron      95: This can be circumvented like so:
                     96: .Pp
1.24      jakemsr    97: .Dl $ (cat file.au; audioctl -f /dev/audioctl) \*(Gt /dev/audio
1.1       provos     98: or
1.16      jmc        99: .Bd -literal -offset indent -compact
1.25      ratchov   100: $ (audioctl -f /dev/audioctl play.block_size=1024; cat file.au) \e
1.19      jmc       101:        \*(Gt /dev/audio
1.16      jmc       102: .Ed
1.1       provos    103: .Sh SEE ALSO
1.19      jmc       104: .Xr aucat 1 ,
                    105: .Xr cdio 1 ,
1.1       provos    106: .Xr mixerctl 1 ,
                    107: .Xr audio 4 ,
                    108: .Xr sysctl 8
                    109: .Sh HISTORY
                    110: The
                    111: .Nm
                    112: command first appeared in
                    113: .Nx 1.3 .