summaryrefslogtreecommitdiffstats
path: root/share/man/man4/pcm.4
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-06-16 08:33:57 +0000
committerru <ru@FreeBSD.org>2004-06-16 08:33:57 +0000
commitaa52a5a900bdec01cd64392151f45ae2b913614b (patch)
tree45340076f670c5a33c9f8979cfb69f5797c2be57 /share/man/man4/pcm.4
parent075deb0c4c016fbd1931955599b44e3592fa397c (diff)
downloadFreeBSD-src-aa52a5a900bdec01cd64392151f45ae2b913614b.zip
FreeBSD-src-aa52a5a900bdec01cd64392151f45ae2b913614b.tar.gz
Assorted markup, spelling, and grammar fixes.
Diffstat (limited to 'share/man/man4/pcm.4')
-rw-r--r--share/man/man4/pcm.486
1 files changed, 52 insertions, 34 deletions
diff --git a/share/man/man4/pcm.4 b/share/man/man4/pcm.4
index 3179aca..718d8c4 100644
--- a/share/man/man4/pcm.4
+++ b/share/man/man4/pcm.4
@@ -31,7 +31,9 @@
.Sh NAME
.Nm pcm ,
.Nm snd
-.Nd FreeBSD PCM audio device infrastructure
+.Nd
+.Fx
+PCM audio device infrastructure
.Sh SYNOPSIS
For a card with bridge driver support, and a PnP card:
.Cd "device pcm"
@@ -106,33 +108,37 @@ in
.Ss Boot Variables
In general, the module
.Pa snd_foo
-corresponds to device foo and can be
-loaded by the boot loader via
-.Pa boot/loader.conf
+corresponds to
+.Cd "device foo"
+and can be
+loaded by the boot
+.Xr loader 8
+via
+.Xr loader.conf 5
or from the command line using the
.Xr kldload 8
utility.
Options which can be specified in
.Pa /boot/loader.conf
include:
-.Bl -tag -width snd_emu10k1_load -offset indent
+.Bl -tag -width ".Va snd_emu10k1_load" -offset indent
.It Va snd_driver_load
-.Pq Dq NO
+.Pq Dq Li NO
If set to
-.Dq YES ,
+.Dq Li YES ,
this option loads all available drivers.
.It Va snd_emu10k1_load
-.Pq Dq NO
+.Pq Dq Li NO
If set to
-.Dq YES ,
-Only the SoundBlaster 5.1 driver and dependent modules will be loaded.
+.Dq Li YES ,
+only the SoundBlaster 5.1 driver and dependent modules will be loaded.
.It Va snd_foo_load
-.Pq Dq NO
+.Pq Dq Li NO
If set to
-.Dq YES ,
+.Dq Li YES ,
load driver for card/chipset foo.
.El
-.Ss VCHANS
+.Ss VCHANs
Each device can optionally support more playback channels
that physical hardware provides by using
.Dq virtual channels
@@ -145,8 +151,8 @@ interface but can only be manipulated while the device is inactive.
.Ss Runtime Configuration
The following
.Xr sysctl 8
-tunables are available:
-.Bl -tag -width ".It Va hw.snd.report_soft_formats" -offset indent
+variables are available:
+.Bl -tag -width ".Va hw.snd.report_soft_formats" -offset indent
.It Va hw.snd.pcm%d.buffersize
Configure the amount of
.Tn DMA
@@ -167,7 +173,7 @@ the default device for
Equivalent to a symlink from
.Pa /dev/dsp
to
-.Pa /dev/dsp${hw.snd.unit} .
+.Pa /dev/dsp Ns Va ${hw.snd.unit} .
.It Va hw.snd.report_soft_formats
Controls the internal format conversion if it is
available transparently to the application software.
@@ -178,15 +184,21 @@ Level of verbosity for the
.Pa /dev/sndstat
device.
Higher values include more output and the highest level,
-three, should be used when reported problems.
+three, should be used when reporting problems.
Other options include:
-0 - Installed devices and their allocated bus resources.
-1 - The number of playback, record, virtual channels, and
+.Bl -tag -width 2n
+.It 0
+Installed devices and their allocated bus resources.
+.It 1
+The number of playback, record, virtual channels, and
flags per device.
-2 - Channel information per device including the channel's
+.It 2
+Channel information per device including the channel's
current format, speed, and pseudo device statistics such as
buffer overruns and buffer underruns.
-3 - File names and versions of the currently sound loaded modules.
+.It 3
+File names and versions of the currently sound loaded modules.
+.El
.It Va hw.snd.maxautovchans
Global
.Tn VCHAN
@@ -225,7 +237,9 @@ The driver supports most of the
.Fn ioctl
functions, and most applications work unmodified.
A few differences exist, while memory mapped playback is
-supported natively and in Linux emulation, memory mapped recording is
+supported natively and in
+.Tn Linux
+emulation, memory mapped recording is
not due to
.Tn VM
system design.
@@ -236,7 +250,7 @@ See
for a complete list of the supported
.Fn ioctl
functions.
-.Ss SUPPORTED CARDS
+.Ss Supported Cards
Below we include a list of supported codecs/cards.
If your sound card
is not listed here, it may be supported by a bridge driver.
@@ -254,12 +268,13 @@ not wired to the ISA DMA controller.
.It Yamaha OPL-SAx (ISA)
Works perfectly in all modes.
This chip is used in several PnP cards,
-but also (in non-PnP mode) on motherboards and laptops (e.g. the
+but also (in non-PnP mode) on motherboards and laptops (e.g., the
Toshiba Libretto).
.It OPTi931 (ISA)
The chip is buggy, but the driver has many workarounds to make it work
in full duplex because for some time these were the only full duplex
-cards I could find. u-law formats uses U8 format internally because of
+cards I could find.
+U-law format uses U8 format internally because of
a bug in the chip.
.It Trident 4DWave DX/NX (PCI)
.It ENSONIQ AudioPCI ES1370/1371 (PCI)
@@ -273,7 +288,7 @@ The
drivers may create the following
device nodes:
.Pp
-.Bl -tag -width "/dev/dspr%d.%dXXX" -compact
+.Bl -tag -width ".Pa /dev/audio%d.%d" -compact
.It Pa /dev/audio%d.%d
Sparc-compatible audio device.
.It Pa /dev/dsp%d.%d
@@ -292,36 +307,39 @@ status, including all channels and drivers.
.Pp
The first number in the device node
represents the unit number of the
-.Nm PCM
+.Nm
device.
All
.Nm
-PCM
devices are listed
in
-.Pa /dev/sndstat.
+.Pa /dev/sndstat .
Additional messages are sometimes recorded when the
device is probed and attached, these messages can be viewed with the
.Xr dmesg 8
utility.
.Sh DIAGNOSTICS
-.Bl -tag -width 2m
+.Bl -diag
.It ac97: dac not ready
AC97 codec is not likely to be accompanied with the sound card.
.It unsupported subdevice XX
A device node is not created properly.
.El
.Sh BUGS
-Some features of your cards (e.g. global volume control) might not
+Some features of your cards (e.g., global volume control) might not
be supported on all devices.
.Sh HISTORY
The
.Nm
device driver first appeared in
-.Fx 2.2.6 written by Luigi Rizzo.
+.Fx 2.2.6
+written by
+.An Luigi Rizzo .
It was later
rewritten in
-.Fx 4.0 by Cameron Grant.
+.Fx 4.0
+by
+.An Cameron Grant .
The API evolved from the VOXWARE
standard which later became OSS standard.
.Sh SEE ALSO
@@ -349,4 +367,4 @@ later revised the device driver for
.An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp
revised this manual page.
It was then rewritten for
-.Fx 5.2 . \ No newline at end of file
+.Fx 5.2 .
OpenPOWER on IntegriCloud