xref: /netbsd/usr.bin/audio/ctl/audioctl.1 (revision c4a72b64)
1.\" $NetBSD: audioctl.1,v 1.16 2002/10/13 01:06:42 wiz Exp $
2.\"
3.\" Copyright (c) 1997, 1999 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Author: Lennart Augustsson and Charles M. Hannum
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 January 27, 2002
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 d Ar device
45.Op Fl n
46.Fl a
47.Nm ""
48.Op Fl d Ar device
49.Op Fl n
50.Ar name ...
51.Nm ""
52.Op Fl d Ar device
53.Op Fl n
54.Fl w
55.Ar name=value ...
56.Sh DESCRIPTION
57The
58.Nm
59command displays or sets various audio system driver variables.
60If a list of variables is present on the command line, then
61.Nm
62prints the current value of those variables for the specified device.
63If the
64.Fl a
65flag is specified, all variables for the device are printed.
66If the
67.Fl w
68flag is specified
69.Nm
70attempts to set the specified variables to the given values.
71.Pp
72The
73.Fl d
74flag can be used to give an alternative audio control device, the default is
75.Pa /dev/audioctl0 .
76.Pp
77The
78.Fl n
79flag suppresses printing of the variable name.
80.Sh ENVIRONMENT
81.Bl -tag -width AUDIOCTLDEVICE
82.It Pa AUDIOCTLDEVICE
83the audio control device to use.
84.El
85.Sh FILES
86.Bl -tag -width /dev/audioctl0 -compact
87.It Pa /dev/audio0
88audio I/O device (resets on open)
89.It Pa /dev/audioctl0
90audio control device
91.It Pa /dev/sound0
92audio I/O device (does not reset on open)
93.El
94.Sh EXAMPLES
95To set the playing sampling rate to 11025, you can use
96.Dl audioctl -w play.sample_rate=11025
97To set all of the play parameters for CD-quality audio, you can use
98.Dl audioctl -w play=44100,2,16,slinear_le
99Note that many of the variables that can be inspected and changed with
100.Nm
101are reset when
102.Pa /dev/audio0
103is opened.
104This can be circumvented by using
105.Pa /dev/sound0
106instead.
107.Sh SEE ALSO
108.Xr audioplay 1 ,
109.Xr audiorecord 1 ,
110.Xr mixerctl 1 ,
111.Xr audio 4 ,
112.Xr sysctl 8
113.Sh HISTORY
114The
115.Nm
116command first appeared in
117.Nx 1.3 .
118.Sh COMPATIBILITY
119The old
120.Fl f
121flag is still supported.
122This support will be removed eventually.
123