From 7c38545a748236c52dbdb6b1652d1b3a54819926 Mon Sep 17 00:00:00 2001 From: brueffer Date: Sat, 20 May 2006 09:39:28 +0000 Subject: Convert to use a SYNPOSIS section that mentions kernel modules. Also add "device scbus" where needed. MFC after: 3 days --- share/man/man4/aha.4 | 16 ++++++++++++++-- share/man/man4/ahb.4 | 16 ++++++++++++++-- share/man/man4/ahc.4 | 25 +++++++++++++++++++------ share/man/man4/ahd.4 | 25 ++++++++++++------------- share/man/man4/arcmsr.4 | 14 +++++++++++++- share/man/man4/ciss.4 | 12 ++++++++++++ share/man/man4/hptmv.4 | 12 ++++++++++++ share/man/man4/ida.4 | 16 ++++++++++++++-- share/man/man4/isp.4 | 18 ++++++++++++++---- share/man/man4/ispfw.4 | 12 ++++++++++++ share/man/man4/mlx.4 | 16 ++++++++++++++-- share/man/man4/mly.4 | 20 ++++++++++++++++---- share/man/man4/mpt.4 | 14 +++++++++++++- share/man/man4/pst.4 | 14 +++++++++++++- share/man/man4/trm.4 | 13 +++++++++++++ share/man/man4/twa.4 | 13 +++++++++++++ share/man/man4/twe.4 | 16 ++++++++++++++-- 17 files changed, 232 insertions(+), 40 deletions(-) diff --git a/share/man/man4/aha.4 b/share/man/man4/aha.4 index e260707..f0f8aca 100644 --- a/share/man/man4/aha.4 +++ b/share/man/man4/aha.4 @@ -33,8 +33,20 @@ .Nm aha .Nd Adaptec SCSI host adapter driver .Sh SYNOPSIS -.Cd device aha -.Cd device scbus +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device scbus" +.Cd "device aha" +.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 +aha_load="YES" +.Ed .Pp In .Pa /boot/device.hints : diff --git a/share/man/man4/ahb.4 b/share/man/man4/ahb.4 index b08e318..6ef9993 100644 --- a/share/man/man4/ahb.4 +++ b/share/man/man4/ahb.4 @@ -33,8 +33,20 @@ .Nm ahb .Nd Adaptec EISA SCSI host adapter driver .Sh SYNOPSIS -.Cd device ahb -.Cd device scbus +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device scbus" +.Cd "device ahb" +.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 +ahb_load="YES" +.Ed .Sh DESCRIPTION This driver provides access to the .Tn SCSI diff --git a/share/man/man4/ahc.4 b/share/man/man4/ahc.4 index 6453c80..cc5db4c 100644 --- a/share/man/man4/ahc.4 +++ b/share/man/man4/ahc.4 @@ -33,22 +33,35 @@ .Nm ahc .Nd Adaptec VL/EISA/PCI SCSI host adapter 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 scbus" +.Cd "device ahc" +.Pp For one or more VL/EISA cards: -.Cd device eisa -.Cd device ahc +.Cd "device eisa" .Pp For one or more PCI cards: -.Cd device pci -.Cd device ahc +.Cd "device pci" .Pp To allow PCI adapters to use memory mapped I/O if enabled: .Cd options AHC_ALLOW_MEMIO .Pp To configure one or more controllers to assume the target role: .Cd options AHC_TMODE_ENABLE +.Ed .Pp -For one or more SCSI busses: -.Cd device scbus +Alternatively, to load the driver as a +module at boot time, place the following lines in +.Xr loader.conf 5 : +.Bd -literal -offset indent +ahc_load="YES" +ahc_eisa_load="YES" +ahc_isa_load="YES" +ahc_pci_load="YES" +.Ed .Sh DESCRIPTION This driver provides access to the .Tn SCSI diff --git a/share/man/man4/ahd.4 b/share/man/man4/ahd.4 index 260036b..e00c427 100644 --- a/share/man/man4/ahd.4 +++ b/share/man/man4/ahd.4 @@ -35,29 +35,28 @@ .Nm ahd .Nd Adaptec PCI/PCI-X Ultra320 SCSI host adapter driver .Sh SYNOPSIS -For one or more PCI/PCI-X cards: -.Bd -ragged -offset indent -compact -.Cd device pci -.Cd device ahd -.Ed +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device pci" +.Cd "device scbus" +.Cd "device ahd" .Pp To compile in debugging code: -.Bd -ragged -offset indent -compact .Cd options AHD_DEBUG .Cd options AHD_DEBUG_OPTS= .Cd options AHD_REG_PRETTY_PRINT -.Ed .Pp To configure one or more controllers to assume the target role: -.Bd -ragged -offset indent -compact .Cd options AHD_TMODE_ENABLE= .Ed .Pp -For one or more -.Tn SCSI -busses: -.Bd -ragged -offset indent -compact -.Cd device scbus +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +ahd_load="YES" .Ed .Sh DESCRIPTION This driver provides access to the diff --git a/share/man/man4/arcmsr.4 b/share/man/man4/arcmsr.4 index 4f305e1..856b688 100644 --- a/share/man/man4/arcmsr.4 +++ b/share/man/man4/arcmsr.4 @@ -31,10 +31,22 @@ .Nm arcmsr .Nd Areca SATA II RAID Controller driver .Sh SYNOPSIS -.Cd "device arcmsr" +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device pci" .Cd "device scbus" .Cd "device da" +.Cd "device arcmsr" +.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 +arcmsr_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/ciss.4 b/share/man/man4/ciss.4 index cb704a5..a896e4e 100644 --- a/share/man/man4/ciss.4 +++ b/share/man/man4/ciss.4 @@ -9,8 +9,20 @@ .Nm ciss .Nd Common Interface for SCSI-3 Support 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 scbus" .Cd "device ciss" +.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 +ciss_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/hptmv.4 b/share/man/man4/hptmv.4 index e472f01..0ae152a 100644 --- a/share/man/man4/hptmv.4 +++ b/share/man/man4/hptmv.4 @@ -31,7 +31,19 @@ .Nm hptmv .Nd "HighPoint RocketRAID 182x device driver" .Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device hptmv" +.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 +hptmv_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/ida.4 b/share/man/man4/ida.4 index 5b91506..01e0267 100644 --- a/share/man/man4/ida.4 +++ b/share/man/man4/ida.4 @@ -9,8 +9,20 @@ .Nm ida .Nd Compaq Intelligent Drive Array Controllers .Sh SYNOPSIS -.Cd device scbus -.Cd device ida +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device scbus" +.Cd "device ida" +.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 +ida_load="YES" +.Ed .Sh DESCRIPTION The Compaq Intelligent Drive Array (IDA) technology is used to distribute data across an array of hard drives. diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index 13dac1f..7a3d2b4 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -36,10 +36,20 @@ .Nm isp .Nd Qlogic based SCSI and FibreChannel SCSI Host Adapters .Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device scbus" .Cd "device isp" -.Pp -For one or more SCSI busses: -.Cd device scbus0 +.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 +isp_load="YES" +.Ed .Sh DESCRIPTION This driver provides access to .Tn SCSI @@ -67,7 +77,7 @@ requires tagging). Fabric support is enabled by default (but may be contingent upon the correct firmware being loaded). .Sh FIRMWARE -Firmware is now available if the +Firmware is available if the .Xr ispfw 4 module is loaded during bootstrap (q.v.). .Pp diff --git a/share/man/man4/ispfw.4 b/share/man/man4/ispfw.4 index 5eb4e62..5755501 100644 --- a/share/man/man4/ispfw.4 +++ b/share/man/man4/ispfw.4 @@ -29,7 +29,19 @@ .Nm ispfw .Nd "Firmware Module for Qlogic based SCSI and FibreChannel SCSI Host Adapters" .Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device ispfw" +.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 +ispfw_load="YES" +.Ed .Sh DESCRIPTION This trivial driver provides access to firmware sets for the Qlogic based SCSI and FibreChannel SCSI Host Adapters. diff --git a/share/man/man4/mlx.4 b/share/man/man4/mlx.4 index 2c26ade..696d048 100644 --- a/share/man/man4/mlx.4 +++ b/share/man/man4/mlx.4 @@ -32,8 +32,20 @@ .Nm mlx .Nd Mylex DAC-family RAID driver .Sh SYNOPSIS -.Cd device pci -.Cd device mlx +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device pci" +.Cd "device mlx" +.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 +mlx_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/mly.4 b/share/man/man4/mly.4 index a57c603..3affcac 100644 --- a/share/man/man4/mly.4 +++ b/share/man/man4/mly.4 @@ -31,10 +31,22 @@ .Nm mly .Nd Mylex AcceleRAID/eXtremeRAID family driver .Sh SYNOPSIS -.Cd device pci -.Cd device mly -.Cd device scbus -.Cd device da +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device pci" +.Cd "device scbus" +.Cd "device da" +.Cd "device mly" +.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 +mly_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/mpt.4 b/share/man/man4/mpt.4 index 9d5e6c2..62a915e 100644 --- a/share/man/man4/mpt.4 +++ b/share/man/man4/mpt.4 @@ -42,8 +42,20 @@ .Nm mpt .Nd LSI Fusion-MPT SCSI/Fibre Channel driver .Sh SYNOPSIS -.Cd "device mpt" +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device scbus" +.Cd "device mpt" +.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 +mpt_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/pst.4 b/share/man/man4/pst.4 index 553f5c1..f207e2d 100644 --- a/share/man/man4/pst.4 +++ b/share/man/man4/pst.4 @@ -32,7 +32,19 @@ .Nm pst .Nd device driver for Promise Supertrak SX6000 .Sh SYNOPSIS -.Cd device pst +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device pst" +.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 +pst_load="YES" +.Ed .Sh DESCRIPTION This driver is for the Promise Supertrak SX6000 ATA hardware RAID controller. It supports (in hardware) RAID levels 0, 1, 0+1, 3, 5 and JBOD on up to diff --git a/share/man/man4/trm.4 b/share/man/man4/trm.4 index d56ed43..6180c94 100644 --- a/share/man/man4/trm.4 +++ b/share/man/man4/trm.4 @@ -34,7 +34,20 @@ .Nm trm .Nd Tekram TRM-S1040 ASIC based PCI SCSI host adapter 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 scbus" .Cd "device trm" +.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 +trm_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/twa.4 b/share/man/man4/twa.4 index dc6071b..ed6b675 100755 --- a/share/man/man4/twa.4 +++ b/share/man/man4/twa.4 @@ -32,7 +32,20 @@ .Nm twa .Nd 3ware 9000/9500/9550 series SATA RAID controllers 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 scbus" .Cd "device twa" +.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 +twa_load="YES" +.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/twe.4 b/share/man/man4/twe.4 index a4a0ea1..fc73a01 100644 --- a/share/man/man4/twe.4 +++ b/share/man/man4/twe.4 @@ -31,8 +31,20 @@ .Nm twe .Nd 3ware 5000/6000/7000/8000 series PATA/SATA RAID adapter driver .Sh SYNOPSIS -.Cd device pci -.Cd device twe +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device pci" +.Cd "device twe" +.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 +twe_load="YES" +.Ed .Sh DESCRIPTION The .Nm -- cgit v1.1