xref: /netbsd-src/usr.bin/audiocfg/audiocfg.1 (revision 35fbfbb85b1e40a71a76e29322fb9818f4231459)

.\"	$NetBSD: audiocfg.1,v 1.8 2021/04/07 09:58:58 nia Exp $
.\"
.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Thomas Klausner.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 7, 2021
.Dt AUDIOCFG 1
.Os
.Sh NAME
.Nm audiocfg
.Nd configure default audio device
.Sh SYNOPSIS
.Nm
.Cm list
.Op Ar index
.Nm
.Cm default
.Ar index
.Nm
.Cm set
.Ar index
.Ar direction
.Ar encoding
.Ar precision
.Ar channels
.Ar sample_rate
.Nm
.Cm test
.Ar index
.Sh DESCRIPTION
The
.Nm
utility helps maintaining the audio and mixer device symlinks.
.Pp
Run with
.Dq Cm list ,
it lists the available audio devices and shows the currently selected
default audio device.
.Pp
Run with
.Dq Cm set ,
it sets the hardware format.
The
.Ar direction
is represented by either of 'p' (playback) or 'r' (record), or both of them.
This indicates the direction you want to set.
The remaining parameters
.Ar encoding ,
.Ar precision ,
.Ar channels ,
and
.Ar sample_rate
indicate the hardware format you want to set.
These parameters must be selected from the candidates displayed by
.Nm
.Cm list .
.Pp
Called with
.Dq Cm test ,
it plays a tone of 2 seconds for each channel of the device with the index
.Ar index .
Called with
.Dq Cm default ,
it sets the default audio device to the one with the index
.Ar index .
.Pp
.Nm
needs access to
.Pa /dev/drvctl
and write access to
.Pa /dev
(when used with
.Dq Cm default )
to work.
.Sh FILES
.Bl -tag -width 10n
.It Pa /dev/audio
Symlink to default audio device.
.It Pa /dev/audio[0-9]*
Available audio devices.
.It Pa /dev/audioctl
Symlink to default audio control device.
.It Pa /dev/audioctl[0-9]*
Available audio control devices.
.It Pa /dev/drvctl
Used for finding the corresponding audio driver to an audio device.
.It Pa /dev/mixer
Symlink to default mixer device.
.It Pa /dev/mixer[0-9]*
Available mixer devices.
.It Pa /dev/sound
Symlink to default audio device (for the difference to
.Pa /dev/audio ,
see
.Xr audio 4 ) .
.It Pa /dev/sound[0-9]*
Available audio devices.
.El
.Sh EXAMPLES
Configure audio device 0 for playing BluRay 5.1 surround sound:
.Dl $ audiocfg set 0 p slinear_le 16 6 48000
.Pp
Configure audio device 0 for playing CD quality audio:
.Dl $ audiocfg set 0 p slinear_le 16 2 44100
.Sh SEE ALSO
.Xr audioplay 1 ,
.Xr audiorecord 1 ,
.Xr audio 4 ,
.Xr drvctl 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Nx 6.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility was originally written by
.An Jared McNeill .
This manual page was written by
.An Thomas Klausner .