Return to audioctl.1 CVS log

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

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

1.16    ! jmc         1: .\" $OpenBSD: audioctl.1,v 1.15 2003/06/10 09:12:09 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: .\"
                     36: .Dd May 4, 1997
                     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.1       provos     55: .Fl w
1.5       aaron      56: .Ar name=value
                     57: .Op Ar ...
1.1       provos     58: .Sh DESCRIPTION
1.7       aaron      59: The
1.1       provos     60: .Nm
                     61: command displays or sets various audio system driver variables.
1.5       aaron      62: If a list of variables is present on the command line,
1.1       provos     63: .Nm
                     64: prints the current value of those variables for the specified device.
1.8       aaron      65: By default,
1.1       provos     66: .Nm
1.8       aaron      67: operates on the
                     68: .Pa /dev/audioctl
                     69: device.
1.1       provos     70: .Pp
1.8       aaron      71: The options are as follows:
1.10      aaron      72: .Bl -tag -width Ds
1.8       aaron      73: .It Fl a
                     74: Print all device variables and their current values.
                     75: .It Fl w Ar name=value
                     76: Attempt to set the specified variable
                     77: .Ar name
                     78: to
                     79: .Ar value .
                     80: .It Fl f Ar file
                     81: Specify an alternative audio control device.
                     82: .It Fl n
                     83: Suppress printing of the variable name.
                     84: .El
1.15      jmc        85: .Sh ENVIRONMENT
                     86: .Bl -tag -width AUDIOCTLDEVICE
                     87: .It Ev AUDIOCTLDEVICE
                     88: Audio control device to use.
                     89: .El
                     90: .Sh FILES
                     91: .Bl -tag -width /dev/audioctl
                     92: .It Pa /dev/audioctl
                     93: default audio control device
                     94: .El
1.1       provos     95: .Sh EXAMPLES
                     96: To set the playing sampling rate to 11025 you can enter
1.8       aaron      97: .Pp
1.13      deraadt    98: .Dl $ audioctl -w play.sample_rate=11025
1.8       aaron      99: .Pp
1.1       provos    100: Note that many of the variables that can be inspected and changed
1.8       aaron     101: are reset when the device is opened.
                    102: This can be circumvented like so:
                    103: .Pp
1.13      deraadt   104: .Dl $ (cat file.au; audioctl -f /dev/stdout -a) > /dev/audio
1.1       provos    105: or
1.16    ! jmc       106: .Bd -literal -offset indent -compact
        !           107: $ (audioctl -f /dev/stdout -w blocksize=1024; cat file.au) \e
        !           108:        > /dev/audio
        !           109: .Ed
1.1       provos    110: .Sh SEE ALSO
                    111: .Xr mixerctl 1 ,
                    112: .Xr audio 4 ,
                    113: .Xr sysctl 8
                    114: .Sh HISTORY
                    115: The
                    116: .Nm
                    117: command first appeared in
                    118: .Nx 1.3 .