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