Annotation of src/usr.bin/audioctl/audioctl.1, Revision 1.1
1.1 ! provos 1: .\" $NetBSD: audioctl.1,v 1.5 1997/10/18 12:05:22 lukem Exp $
! 2: .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
! 3: .\" All rights reserved.
! 4: .\"
! 5: .\" Author: Lennart Augustsson
! 6: .\"
! 7: .\" Redistribution and use in source and binary forms, with or without
! 8: .\" modification, are permitted provided that the following conditions
! 9: .\" are met:
! 10: .\" 1. Redistributions of source code must retain the above copyright
! 11: .\" notice, this list of conditions and the following disclaimer.
! 12: .\" 2. Redistributions in binary form must reproduce the above copyright
! 13: .\" notice, this list of conditions and the following disclaimer in the
! 14: .\" documentation and/or other materials provided with the distribution.
! 15: .\" 3. All advertising materials mentioning features or use of this software
! 16: .\" must display the following acknowledgement:
! 17: .\" This product includes software developed by the NetBSD
! 18: .\" Foundation, Inc. and its contributors.
! 19: .\" 4. Neither the name of The NetBSD Foundation nor the names of its
! 20: .\" contributors may be used to endorse or promote products derived
! 21: .\" from this software without specific prior written permission.
! 22: .\"
! 23: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
! 24: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
! 25: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
! 26: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
! 27: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
! 28: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
! 29: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
! 30: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
! 31: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
! 32: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! 33: .\" POSSIBILITY OF SUCH DAMAGE.
! 34: .\"
! 35: .Dd May 4, 1997
! 36: .Dt AUDIOCTL 1
! 37: .Os
! 38: .Sh NAME
! 39: .Nm audioctl
! 40: .Nd control audio device
! 41: .Sh SYNOPSIS
! 42: .Nm
! 43: .Op Fl f Ar file
! 44: .Op Fl n
! 45: .Fl a
! 46: .Nm ""
! 47: .Op Fl f Ar file
! 48: .Op Fl n
! 49: .Ar name ...
! 50: .Nm ""
! 51: .Op Fl f Ar file
! 52: .Op Fl n
! 53: .Fl w
! 54: .Ar name=value ...
! 55: .Sh DESCRIPTION
! 56: The
! 57: .Nm
! 58: command displays or sets various audio system driver variables.
! 59: If a list of variables is present on the command line, then
! 60: .Nm
! 61: prints the current value of those variables for the specified device.
! 62: If the
! 63: .Fl a
! 64: flag is specified, all variables for the device are printed.
! 65: If the
! 66: .Fl w
! 67: flag is specified
! 68: .Nm
! 69: attempts to set the specified variables to the given values.
! 70: .Pp
! 71: The
! 72: .Fl f
! 73: flag can be used to give an alternative audio control device, the default is
! 74: .Pa /dev/audioctl .
! 75: .Pp
! 76: The
! 77: .Fl n
! 78: flag suppresses printing of the variable name.
! 79: .Sh EXAMPLES
! 80: To set the playing sampling rate to 11025 you can enter
! 81: .Dl audioctl -w play.sample_rate=11025
! 82: Note that many of the variables that can be inspected and changed
! 83: with
! 84: .Nm
! 85: are reset when the device is opened. This can be circumvented
! 86: like this
! 87: .Dl (cat file.au; audioctl -f /dev/stdout -a) > /dev/audio
! 88: or
! 89: .Dl (audioctl -f /dev/stdout -w blocksize=1024; cat file.au) > /dev/audio
! 90: .Sh FILES
! 91: .Bl -tag -width /dev/audioctl
! 92: .It Pa /dev/audioctl
! 93: audio device
! 94: .El
! 95: .Sh SEE ALSO
! 96: .Xr mixerctl 1 ,
! 97: .Xr audio 4 ,
! 98: .Xr sysctl 8
! 99: .Sh HISTORY
! 100: The
! 101: .Nm
! 102: command first appeared in
! 103: .Nx 1.3 .