Annotation of src/usr.bin/audioctl/audioctl.1, Revision 1.5
1.5 ! aaron 1: .\" $OpenBSD: audioctl.1,v 1.4 1998/04/30 13:46:16 provos 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
27: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
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
43: .Nm
44: .Op Fl f Ar file
45: .Op Fl n
46: .Fl a
1.2 millert 47: .br
48: .Nm
1.1 provos 49: .Op Fl f Ar file
50: .Op Fl n
1.5 ! aaron 51: .Ar name
! 52: .Op Ar ...
1.2 millert 53: .br
54: .Nm
1.1 provos 55: .Op Fl f Ar file
56: .Op Fl n
57: .Fl w
1.5 ! aaron 58: .Ar name=value
! 59: .Op Ar ...
1.1 provos 60: .Sh DESCRIPTION
61: The
62: .Nm
63: command displays or sets various audio system driver variables.
1.5 ! aaron 64: If a list of variables is present on the command line,
1.1 provos 65: .Nm
66: prints the current value of those variables for the specified device.
67: If the
68: .Fl a
69: flag is specified, all variables for the device are printed.
70: If the
71: .Fl w
1.5 ! aaron 72: flag is specified,
1.1 provos 73: .Nm
74: attempts to set the specified variables to the given values.
75: .Pp
76: The
77: .Fl f
1.5 ! aaron 78: flag can be used to give an alternative audio control device. The default is
1.1 provos 79: .Pa /dev/audioctl .
80: .Pp
81: The
82: .Fl n
83: flag suppresses printing of the variable name.
84: .Sh EXAMPLES
85: To set the playing sampling rate to 11025 you can enter
86: .Dl audioctl -w play.sample_rate=11025
87: Note that many of the variables that can be inspected and changed
88: with
89: .Nm
90: are reset when the device is opened. This can be circumvented
91: like this
92: .Dl (cat file.au; audioctl -f /dev/stdout -a) > /dev/audio
93: or
94: .Dl (audioctl -f /dev/stdout -w blocksize=1024; cat file.au) > /dev/audio
95: .Sh FILES
96: .Bl -tag -width /dev/audioctl
97: .It Pa /dev/audioctl
1.4 provos 98: audio control device
1.1 provos 99: .El
1.4 provos 100: .Sh ENVIRONMENT
101: .Bl -tag -width AUDIOCTLDEVICE
1.5 ! aaron 102: .It Ev AUDIOCTLDEVICE
! 103: The audio control device to use.
1.1 provos 104: .Sh SEE ALSO
105: .Xr mixerctl 1 ,
106: .Xr audio 4 ,
107: .Xr sysctl 8
108: .Sh HISTORY
109: The
110: .Nm
111: command first appeared in
112: .Nx 1.3 .