xref: /netbsd-src/usr.bin/audiocfg/audiocfg.1 (revision f3cfa6f6ce31685c6c4a758bc430e69eb99f50a4)
1.\"	$NetBSD: audiocfg.1,v 1.5 2019/05/09 09:34:58 wiz Exp $
2.\"
3.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Thomas Klausner.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd May 8, 2019
31.Dt AUDIOCFG 1
32.Os
33.Sh NAME
34.Nm audiocfg
35.Nd configure default audio device
36.Sh SYNOPSIS
37.Nm
38.Cm list
39.Nm
40.Cm default
41.Ar index
42.Nm
43.Cm set
44.Ar index
45.Ar direction
46.Ar encoding
47.Ar precision
48.Ar channels
49.Ar sample_rate
50.Nm
51.Cm test
52.Ar index
53.Sh DESCRIPTION
54The
55.Nm
56utility helps maintaining the audio and mixer device symlinks.
57.Pp
58Run with
59.Dq Cm list ,
60it lists the available audio devices and shows the currently selected
61default audio device.
62.Pp
63Run with
64.Dq Cm set ,
65it sets the hardware format.
66The
67.Ar direction
68is represented by either of 'p' (playback) or 'r' (record), or both of them.
69This indicates the direction you want to set.
70The remaining parameters
71.Ar encoding ,
72.Ar precision ,
73.Ar channels ,
74and
75.Ar sample_rate
76indicate the hardware format you want to set.
77These parameters must be selected from the candidates displayed by
78.Nm
79.Cm list .
80.Pp
81Called with
82.Dq Cm test ,
83it plays a tone of 2 seconds for each channel of the device with the index
84.Ar index .
85Called with
86.Dq Cm default ,
87it sets the default audio device to the one with the index
88.Ar index .
89.Pp
90.Nm
91needs access to
92.Pa /dev/drvctl
93and write access to
94.Pa /dev
95(when used with
96.Dq Cm default )
97to work.
98.Sh FILES
99.Bl -tag -width 10n
100.It Pa /dev/audio
101Symlink to default audio device.
102.It Pa /dev/audio[0-9]*
103Available audio devices.
104.It Pa /dev/audioctl
105Symlink to default audio control device.
106.It Pa /dev/audioctl[0-9]*
107Available audio control devices.
108.It Pa /dev/drvctl
109Used for finding the corresponding audio driver to an audio device.
110.It Pa /dev/mixer
111Symlink to default mixer device.
112.It Pa /dev/mixer[0-9]*
113Available mixer devices.
114.It Pa /dev/sound
115Symlink to default audio device (for the difference to
116.Pa /dev/audio ,
117see
118.Xr audio 4 ) .
119.It Pa /dev/sound[0-9]*
120Available audio devices.
121.El
122.Sh SEE ALSO
123.Xr audioplay 1 ,
124.Xr audiorecord 1 ,
125.Xr audio 4 ,
126.Xr drvctl 8
127