Annotation of src/usr.bin/audioctl/audioctl.1, Revision 1.7
1.7 ! aaron 1: .\" $OpenBSD: audioctl.1,v 1.6 1998/12/16 02:38:48 aaron 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.1 provos 44: .Op Fl f Ar file
45: .Op Fl n
46: .Fl a
1.6 aaron 47: .Nm audioctl
1.1 provos 48: .Op Fl f Ar file
49: .Op Fl n
1.5 aaron 50: .Ar name
51: .Op Ar ...
1.6 aaron 52: .Nm audioctl
1.1 provos 53: .Op Fl f Ar file
54: .Op Fl n
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.7 ! aaron 65: If the
1.1 provos 66: .Fl a
67: flag is specified, all variables for the device are printed.
68: If the
69: .Fl w
1.5 aaron 70: flag is specified,
1.1 provos 71: .Nm
72: attempts to set the specified variables to the given values.
73: .Pp
74: The
75: .Fl f
1.5 aaron 76: flag can be used to give an alternative audio control device. The default is
1.1 provos 77: .Pa /dev/audioctl .
78: .Pp
79: The
80: .Fl n
81: flag suppresses printing of the variable name.
82: .Sh EXAMPLES
83: To set the playing sampling rate to 11025 you can enter
84: .Dl audioctl -w play.sample_rate=11025
85: Note that many of the variables that can be inspected and changed
86: with
87: .Nm
88: are reset when the device is opened. This can be circumvented
89: like this
90: .Dl (cat file.au; audioctl -f /dev/stdout -a) > /dev/audio
91: or
92: .Dl (audioctl -f /dev/stdout -w blocksize=1024; cat file.au) > /dev/audio
93: .Sh FILES
94: .Bl -tag -width /dev/audioctl
95: .It Pa /dev/audioctl
1.4 provos 96: audio control device
1.1 provos 97: .El
1.4 provos 98: .Sh ENVIRONMENT
99: .Bl -tag -width AUDIOCTLDEVICE
1.5 aaron 100: .It Ev AUDIOCTLDEVICE
101: The audio control device to use.
1.1 provos 102: .Sh SEE ALSO
103: .Xr mixerctl 1 ,
104: .Xr audio 4 ,
105: .Xr sysctl 8
106: .Sh HISTORY
107: The
108: .Nm
109: command first appeared in
110: .Nx 1.3 .