1.\" $OpenBSD: audioctl.1,v 1.19 2004/07/30 11:48:58 jmc Exp $
2.\" $NetBSD: audioctl.1,v 1.7 1998/04/27 16:55:23 augustss Exp $
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 audioctl
44.Op Fl f Ar file
45.Op Fl n
46.Fl a
47.Nm audioctl
48.Op Fl f Ar file
49.Op Fl n
50.Ar name
51.Op Ar ...
52.Nm audioctl
53.Op Fl f Ar file
54.Op Fl n
55.Ar name Ns = Ns Ar value
56.Op Ar ...
57.Sh DESCRIPTION
58The
59.Nm
60command displays or sets various audio system driver variables.
61If a list of variables is present on the command line,
62.Nm
63prints the current value of those variables for the specified device.
64By default,
65.Nm
66operates on the
67.Pa /dev/audioctl
68device.
69.Pp
70The options are as follows:
71.Bl -tag -width "name=valueXX"
72.It Fl a
73Print all device variables and their current values.
74.It Fl f Ar file
75Specify an alternative audio control device.
76.It Fl n
77Suppress printing of the variable name.
78.It Ar name Ns = Ns Ar value
79Attempt to set the specified variable
80.Ar name
81to
82.Ar value .
83.El
84.Sh ENVIRONMENT
85.Bl -tag -width AUDIOCTLDEVICE
86.It Ev AUDIOCTLDEVICE
87Audio control device to use.
88.El
89.Sh FILES
90.Bl -tag -width /dev/audioctl
91.It Pa /dev/audioctl
92default audio control device
93.El
94.Sh EXAMPLES
95To set the playing sampling rate to 11025 you can enter:
96.Pp
97.Dl $ audioctl play.sample_rate=11025
98.Pp
99Note that many of the variables that can be inspected and changed
100are reset when the
101.Pa /dev/audio
102device is opened.
103This can be circumvented like so:
104.Pp
105.Dl $ (cat file.au; audioctl -f /dev/audioctl -a) \*(Gt /dev/audio
106or
107.Bd -literal -offset indent -compact
108$ (audioctl -f /dev/audioctl blocksize=1024; cat file.au) \e
109	\*(Gt /dev/audio
110.Ed
111.Sh SEE ALSO
112.Xr aucat 1 ,
113.Xr cdio 1 ,
114.Xr mixerctl 1 ,
115.Xr audio 4 ,
116.Xr sysctl 8
117.Sh HISTORY
118The
119.Nm
120command first appeared in
121.Nx 1.3 .
122