try to document the mpath bits i put in yesterday. thanks to miod for the

words that got me going.

we might not want to make mpath look as special as it is in the scsi
manpage, but i'll let others make the call and fix it in the tree.

6 files changed, 172 insertions, 15 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index fa34beeee30..26799d1c848 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.520 2011/03/28 15:25:37 claudio Exp $
+#	$OpenBSD: Makefile,v 1.521 2011/04/06 11:54:56 dlg Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -18,7 +18,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	ch.4 ciphy.4 ciss.4 clcs.4 clct.4 cmpci.4 cnw.4 \
 	com.4 crypto.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 \
 	diskmap.4 divert.4 dpt.4 drm.4 \
-	eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 gcu.4 \
+	eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 emc.4 gcu.4 \
 	emu.4 enc.4 endrun.4 envy.4 ep.4 epic.4 esa.4 \
 	eso.4 ess.4 et.4 etphy.4 ex.4 exphy.4 \
 	faith.4 fd.4 fdc.4 fins.4 fintek.4 fms.4 fpa.4 fxp.4 gdt.4 \
@@ -43,7 +43,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	pcfiic.4 pciide.4 pckbc.4 pckbd.4 pcmcia.4 pcn.4 pcppi.4 pcscp.4 \
 	pf.4 pflog.4 pflow.4 pfsync.4 pgt.4 piixpm.4 pim.4 \
 	pms.4 ppb.4 ppp.4 pppoe.4 pty.4 puc.4 pwdog.4 qsphy.4 radio.4 raid.4 \
-	ral.4 random.4 ray.4 rd.4 re.4 rdcphy.4 rgephy.4 ricohrtc.4 \
+	ral.4 random.4 ray.4 rd.4 rdac.4 re.4 rdcphy.4 rgephy.4 ricohrtc.4 \
 	rl.4 rlphy.4 route.4 rsu.4 rt.4 rum.4 run.4 \
 	rtfps.4 rtii.4 rtw.4 safe.4 safte.4 san.4 sbt.4 sbus.4 schsio.4 \
 	scsi.4 sd.4 \
@@ -51,7 +51,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	sequencer.4 sf.4 sf2r.4 sfr.4 sili.4 siop.4 sis.4 sk.4 sl.4 sli.4 \
 	sm.4 softraid.4 spdmem.4 sdtemp.4 speaker.4 sppp.4 sqphy.4 \
 	st.4 ste.4 stge.4 sti.4 \
-	stp.4 sv.4 systrace.4 tcic.4 tcp.4 termios.4 tht.4 ti.4 tl.4 \
+	stp.4 sv.4 sym.4 systrace.4 tcic.4 tcp.4 termios.4 tht.4 ti.4 tl.4 \
 	tlphy.4 thmc.4 tqphy.4 trm.4 trunk.4 tsl.4 tty.4 tun.4 twe.4 txp.4 \
 	txphy.4 uaudio.4 uark.4 uath.4 uberry.4 ubsa.4 ubsec.4 ubt.4 \
 	ucom.4 uchcom.4 ucycom.4 udav.4 udcf.4 udfu.4 udl.4 udp.4 udsbr.4 \
diff --git a/share/man/man4/emc.4 b/share/man/man4/emc.4
new file mode 100644
index 00000000000..b253c33e224
--- /dev/null
+++ b/share/man/man4/emc.4
@@ -0,0 +1,46 @@
+.\"	$OpenBSD: emc.4,v 1.1 2011/04/06 11:54:56 dlg Exp $
+.\"
+.\" Copyright (c) 2011 David Gwynne <dlg@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: April 6 2011 $
+.Dt EMC 4
+.Os
+.Sh NAME
+.Nm emc
+.Nd EMC CLARiiON AX/CX-series SCSI devices
+.Sh SYNOPSIS
+.Cd "emc* at scsibus?"
+.Sh DESCRIPTION
+The
+.Nm
+driver attaches to EMC CLARiiON AX/CX-series SCSI logical units.
+Each path to an active service processor attached to by
+.Nm
+is presented to
+.Xr mpath 4
+which uses it as a backend to the logical unit attached to its own
+.Xr scsibus 4 .
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr intro 4 ,
+.Xr mpath 4 ,
+.Xr scsi 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 5.0 .
+.Sh AUTHORS
+.An David Gwynne Aq dlg@openbsd.org .
diff --git a/share/man/man4/mpath.4 b/share/man/man4/mpath.4
index 3c66f895b15..7414d9c1d06 100644
--- a/share/man/man4/mpath.4
+++ b/share/man/man4/mpath.4
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: mpath.4,v 1.2 2009/08/09 17:57:43 jmc Exp $
+.\"	$OpenBSD: mpath.4,v 1.3 2011/04/06 11:54:56 dlg Exp $
 .\"
 .\" Copyright (c) 2009 David Gwynne <dlg@openbsd.org>
 .\"
@@ -14,27 +14,35 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: August 9 2009 $
+.Dd $Mdocdate: April 6 2011 $
 .Dt MPATH 4
 .Os
 .Sh NAME
 .Nm mpath
 .Nd SCSI multipath
 .Sh SYNOPSIS
+.Cd "emc* at scsibus?"
+.Cd "rdac* at scsibus?"
+.Cd "sym* at scsibus?"
+.Pp
 .Cd "mpath0 at root"
 .Cd "scsibus* at mpath?"
 .Sh DESCRIPTION
 .Nm
-intercepts the attachment of devices on physical SCSI buses
-that could be available via several paths.
-These devices are then presented via the
-.Xr scsibus 4
-attached to
-.Nm .
+provides access, I/O multiplexing, and failover support to SCSI
+logical units that can have multiple physical connections to the
+system.
+It uses connections presented by path drivers, for example
+.Xr sym 4 ,
+as backends to a single device attached to its own
+.Xr scsibus 4 .
 .Sh SEE ALSO
 .Xr ioctl 2 ,
+.Xr emc 4 ,
 .Xr intro 4 ,
-.Xr scsi 4
+.Xr rdac 4 ,
+.Xr scsi 4 ,
+.Xr sym 4
 .Sh HISTORY
 The
 .Nm
diff --git a/share/man/man4/rdac.4 b/share/man/man4/rdac.4
new file mode 100644
index 00000000000..0bb98762f2a
--- /dev/null
+++ b/share/man/man4/rdac.4
@@ -0,0 +1,46 @@
+.\"	$OpenBSD: rdac.4,v 1.1 2011/04/06 11:54:56 dlg Exp $
+.\"
+.\" Copyright (c) 2011 David Gwynne <dlg@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: April 6 2011 $
+.Dt RDAC 4
+.Os
+.Sh NAME
+.Nm rdac
+.Nd Engenio/LSI RDAC SCSI devices
+.Sh SYNOPSIS
+.Cd "rdac* at scsibus?"
+.Sh DESCRIPTION
+The
+.Nm
+driver attaches to Engenio/LSI RDAC SCSI SCSI logical units.
+Each path to an active service processor attached to by
+.Nm
+is presented to
+.Xr mpath 4
+which uses it as a backend to the logical unit attached to its own
+.Xr scsibus 4 .
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr intro 4 ,
+.Xr mpath 4 ,
+.Xr scsi 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 5.0 .
+.Sh AUTHORS
+.An David Gwynne Aq dlg@openbsd.org .
diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4
index 278c9d23582..71c8c258d16 100644
--- a/share/man/man4/scsi.4
+++ b/share/man/man4/scsi.4
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: scsi.4,v 1.32 2010/07/03 09:20:05 krw Exp $
+.\"	$OpenBSD: scsi.4,v 1.33 2011/04/06 11:54:56 dlg Exp $
 .\"
 .\" Copyright (c) 1996
 .\"	Julian Elischer <julian@freebsd.org>.  All rights reserved.
@@ -25,7 +25,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 3 2010 $
+.Dd $Mdocdate: April 6 2011 $
 .Dt SCSI 4
 .Os
 .Sh NAME
@@ -41,6 +41,12 @@
 .Cd "ses* at scsibus?"
 .Cd "st* at scsibus?"
 .Cd "uk* at scsibus?"
+.Pp
+.Cd "# multipath support"
+.Cd "emc* at scsibus?"
+.Cd "rdac* at scsibus?"
+.Cd "sym* at scsibus?"
+.Cd "scsibus* at mpath?"
 .Sh DESCRIPTION
 The
 .Em SCSI
@@ -160,11 +166,15 @@ shows more detailed information including DMA scatter-gather logs.
 .Sh SEE ALSO
 .Xr cd 4 ,
 .Xr ch 4 ,
+.Xr emc 4 ,
 .Xr intro 4 ,
+.Xr mpath 4 ,
+.Xr rdac 4 ,
 .Xr safte 4 ,
 .Xr sd 4 ,
 .Xr ses 4 ,
 .Xr st 4 ,
+.Xr sym 4 ,
 .Xr uk 4 ,
 .Xr scsi 8
 .Sh HISTORY
diff --git a/share/man/man4/sym.4 b/share/man/man4/sym.4
new file mode 100644
index 00000000000..476fd7423d3
--- /dev/null
+++ b/share/man/man4/sym.4
@@ -0,0 +1,47 @@
+.\"	$OpenBSD: sym.4,v 1.1 2011/04/06 11:54:56 dlg Exp $
+.\"
+.\" Copyright (c) 2011 David Gwynne <dlg@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: April 6 2011 $
+.Dt SYM 4
+.Os
+.Sh NAME
+.Nm sym
+.Nd Symmetric access SCSI devices
+.Sh SYNOPSIS
+.Cd "sym* at scsibus?"
+.Sh DESCRIPTION
+The
+.Nm
+driver attaches to SCSI logical units that support symmetric access,
+ie, all paths to the device are as good as each other.
+Each path attached to by
+.Nm
+is presented to
+.Xr mpath 4
+which uses it as a backend to the logical unit attached to its own
+.Xr scsibus 4 .
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr intro 4 ,
+.Xr mpath 4 ,
+.Xr scsi 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 5.0 .
+.Sh AUTHORS
+.An David Gwynne Aq dlg@openbsd.org .