summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjoel <joel@FreeBSD.org>2005-12-15 20:25:41 +0000
committerjoel <joel@FreeBSD.org>2005-12-15 20:25:41 +0000
commit7317a691d63e23258d92993fc937e92e1856fec2 (patch)
tree933f92646f5806cacd53f74d501cf25902313c5e
parentdd0db6b7bf6886d87a27debc3d33ce6dd983aca7 (diff)
downloadFreeBSD-src-7317a691d63e23258d92993fc937e92e1856fec2.zip
FreeBSD-src-7317a691d63e23258d92993fc937e92e1856fec2.tar.gz
Make the SYNOPSIS section a bit more informative.
-rw-r--r--share/man/man4/snd_ad1816.425
-rw-r--r--share/man/man4/snd_als4000.413
-rw-r--r--share/man/man4/snd_cmi.413
-rw-r--r--share/man/man4/snd_cs4281.413
-rw-r--r--share/man/man4/snd_csa.413
-rw-r--r--share/man/man4/snd_ds1.413
-rw-r--r--share/man/man4/snd_emu10k1.413
-rw-r--r--share/man/man4/snd_es137x.413
-rw-r--r--share/man/man4/snd_ess.413
-rw-r--r--share/man/man4/snd_gusc.429
-rw-r--r--share/man/man4/snd_ich.413
-rw-r--r--share/man/man4/snd_maestro.413
-rw-r--r--share/man/man4/snd_maestro3.420
-rw-r--r--share/man/man4/snd_sbc.427
-rw-r--r--share/man/man4/snd_uaudio.413
15 files changed, 206 insertions, 38 deletions
diff --git a/share/man/man4/snd_ad1816.4 b/share/man/man4/snd_ad1816.4
index b2135c1..3d2cb0c 100644
--- a/share/man/man4/snd_ad1816.4
+++ b/share/man/man4/snd_ad1816.4
@@ -24,20 +24,35 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_AD1816 4
.Os
.Sh NAME
.Nm snd_ad1816
.Nd "Analog Devices AD1816 ISA bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_ad1816"
+.Ed
.Pp
-.Cd hint.pcm.0.at="isa"
-.Cd hint.pcm.0.irq="10"
-.Cd hint.pcm.0.drq="1"
-.Cd hint.pcm.0.flags="0x0"
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_ad1816_load="YES"
+.Ed
+.Pp
+Non-PnP cards require the following lines in
+.Xr device.hints 5 :
+.Bd -literal -offset indent
+hint.pcm.0.at="isa"
+hint.pcm.0.irq="10"
+hint.pcm.0.drq="1"
+hint.pcm.0.flags="0x0"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_als4000.4 b/share/man/man4/snd_als4000.4
index 7127eab..a13779a 100644
--- a/share/man/man4/snd_als4000.4
+++ b/share/man/man4/snd_als4000.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_ALS4000 4
.Os
.Sh NAME
.Nm snd_als4000
.Nd "Avance Logic ALS4000 PCI bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_als4000"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_als4000_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_cmi.4 b/share/man/man4/snd_cmi.4
index b441682..d6dc088 100644
--- a/share/man/man4/snd_cmi.4
+++ b/share/man/man4/snd_cmi.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_CMI 4
.Os
.Sh NAME
.Nm snd_cmi
.Nd "CMedia CMI8338/CMI8738 PCI bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_cmi"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_cmi_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_cs4281.4 b/share/man/man4/snd_cs4281.4
index 0cbe188..2b94174 100644
--- a/share/man/man4/snd_cs4281.4
+++ b/share/man/man4/snd_cs4281.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_CS4281 4
.Os
.Sh NAME
.Nm snd_cs4281
.Nd "Crystal Semiconductor CS4281 PCI bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_cs4281"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_cs4281_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_csa.4 b/share/man/man4/snd_csa.4
index 4184c71..415ac15 100644
--- a/share/man/man4/snd_csa.4
+++ b/share/man/man4/snd_csa.4
@@ -25,15 +25,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 18, 2005
+.Dd December 15, 2005
.Dt SND_CSA 4
.Os
.Sh NAME
.Nm snd_csa
.Nd Crystal Semiconductor CS461x/462x/4280 PCI bridge device driver
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_csa"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_csa_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_ds1.4 b/share/man/man4/snd_ds1.4
index cdfbf17..d691924 100644
--- a/share/man/man4/snd_ds1.4
+++ b/share/man/man4/snd_ds1.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_DS1 4
.Os
.Sh NAME
.Nm snd_ds1
.Nd "Yamaha DS-1 PCI bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_ds1"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_ds1_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_emu10k1.4 b/share/man/man4/snd_emu10k1.4
index 42db738..3052f12 100644
--- a/share/man/man4/snd_emu10k1.4
+++ b/share/man/man4/snd_emu10k1.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_EMU10K1 4
.Os
.Sh NAME
.Nm snd_emu10k1
.Nd "SoundBlaster Live! and Audigy PCI bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_emu10k1"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_emu10k1_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_es137x.4 b/share/man/man4/snd_es137x.4
index 3ff95ef..11bc14d 100644
--- a/share/man/man4/snd_es137x.4
+++ b/share/man/man4/snd_es137x.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_ES137X 4
.Os
.Sh NAME
.Nm snd_es137x
.Nd "Ensoniq AudioPCI ES137x bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_es137x"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_es137x_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_ess.4 b/share/man/man4/snd_ess.4
index 5abae10..bd0d6d7 100644
--- a/share/man/man4/snd_ess.4
+++ b/share/man/man4/snd_ess.4
@@ -24,16 +24,27 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 28, 2005
+.Dd December 15, 2005
.Dt SND_ESS 4
.Os
.Sh NAME
.Nm snd_ess
.Nd "Ensoniq ESS ISA PnP/non-PnP bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_ess"
.Cd "device snd_sbc"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_ess_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_gusc.4 b/share/man/man4/snd_gusc.4
index 5cf42d5..6f253b6 100644
--- a/share/man/man4/snd_gusc.4
+++ b/share/man/man4/snd_gusc.4
@@ -25,23 +25,36 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 28, 2004
+.Dd December 15, 2005
.Dt SND_GUSC 4
.Os
.Sh NAME
.Nm snd_gusc
.Nd Gravis UltraSound ISA bridge device driver
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_gusc"
+.Ed
.Pp
-For non-PnP cards, add the following lines in
-.Pa /boot/device.hints .
-.Cd hint.gusc.0.at="isa"
-.Cd hint.gusc.0.port="0x220"
-.Cd hint.gusc.0.irq="5"
-.Cd hint.gusc.0.drq="1"
-.Cd hint.gusc.0.flags="0x13"
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_gusc_load="YES"
+.Ed
+.Pp
+Non-PnP cards require the following lines in
+.Xr device.hints 5 :
+.Bd -literal -offset indent
+hint.gusc.0.at="isa"
+hint.gusc.0.port="0x220"
+hint.gusc.0.irq="5"
+hint.gusc.0.drq="1"
+hint.gusc.0.flags="0x13"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_ich.4 b/share/man/man4/snd_ich.4
index 4738441..40dddae 100644
--- a/share/man/man4/snd_ich.4
+++ b/share/man/man4/snd_ich.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 14, 2005
+.Dd December 15, 2005
.Dt SND_ICH 4
.Os
.Sh NAME
.Nm snd_ich
.Nd "Intel ICH PCI and compatible bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_ich"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_ich_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_maestro.4 b/share/man/man4/snd_maestro.4
index cf01689..d630a33 100644
--- a/share/man/man4/snd_maestro.4
+++ b/share/man/man4/snd_maestro.4
@@ -24,15 +24,26 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 14, 2004
+.Dd December 15, 2005
.Dt SND_MAESTRO 4
.Os
.Sh NAME
.Nm snd_maestro
.Nd "ESS Maestro bridge device driver"
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_maestro"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_maestro_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_maestro3.4 b/share/man/man4/snd_maestro3.4
index 272eee7..3b27cab 100644
--- a/share/man/man4/snd_maestro3.4
+++ b/share/man/man4/snd_maestro3.4
@@ -24,15 +24,27 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 14, 2004
+.Dd December 15, 2005
.Dt SND_MAESTRO3 4
.Os
.Sh NAME
.Nm snd_maestro3
.Nd "ESS Maestro3/Allegro-1 bridge device driver"
.Sh SYNOPSIS
+
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_maestro3"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_maestro3_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
@@ -46,12 +58,6 @@ The firmware for the sound processor is licensed under the GNU Public
License, and thus this driver is not included in the default
.Pa GENERIC
kernel.
-A convenient way to automatically load the driver is to add the line
-.Pp
-.Dl snd_maestro3_load="YES"
-.Pp
-to the file
-.Pa /boot/loader.conf .
.Sh HARDWARE
The
.Nm
diff --git a/share/man/man4/snd_sbc.4 b/share/man/man4/snd_sbc.4
index 210cd78..6c098dc 100644
--- a/share/man/man4/snd_sbc.4
+++ b/share/man/man4/snd_sbc.4
@@ -25,23 +25,36 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 17, 2005
+.Dd December 15, 2005
.Dt SND_SBC 4
.Os
.Sh NAME
.Nm snd_sbc
.Nd Creative Sound Blaster ISA and compatible bridge device driver
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_sbc"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_sbc_load="YES"
+.Ed
.Pp
Non-PnP cards require the following lines in
-.Pa /boot/device.hints :
-.Cd hint.sbc.0.at="isa"
-.Cd hint.sbc.0.port="0x220"
-.Cd hint.sbc.0.irq="5"
-.Cd hint.sbc.0.drq="1"
-.Cd hint.sbc.0.flags="0x15"
+.Xr device.hints 5 :
+.Bd -literal -offset indent
+hint.sbc.0.at="isa"
+hint.sbc.0.port="0x220"
+hint.sbc.0.irq="5"
+hint.sbc.0.drq="1"
+hint.sbc.0.flags="0x15"
+.Ed
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/snd_uaudio.4 b/share/man/man4/snd_uaudio.4
index bf84b04..3cc9d12 100644
--- a/share/man/man4/snd_uaudio.4
+++ b/share/man/man4/snd_uaudio.4
@@ -36,16 +36,27 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 28, 2004
+.Dd December 15, 2005
.Dt SND_UAUDIO 4
.Os
.Sh NAME
.Nm snd_uaudio
.Nd USB audio device driver
.Sh SYNOPSIS
+To compile this driver into the kernel, place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device usb"
.Cd "device snd_uaudio"
+.Ed
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+snd_uaudio_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
OpenPOWER on IntegriCloud