summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUwe Stuehler <uwe@cvs.openbsd.org>2006-11-27 15:49:32 +0000
committerUwe Stuehler <uwe@cvs.openbsd.org>2006-11-27 15:49:32 +0000
commit7e5ef1a9e4d90599ccbb10ee903711ed28ef40ad (patch)
tree7d582b8ad9ddc9fdef11b6fcfe854d6f3af7d33a
parent3aa1f88ffde067514c8934fa39f07e8f329f7aa3 (diff)
document the CDC Ethernet function
-rw-r--r--share/man/man4/Makefile6
-rw-r--r--share/man/man4/cdcef.450
2 files changed, 53 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index a8d96695ca8..764de0efe35 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.395 2006/11/27 11:38:43 deraadt Exp $
+# $OpenBSD: Makefile,v 1.396 2006/11/27 15:49:31 uwe Exp $
MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
@@ -9,8 +9,8 @@ MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
auich.4 autri.4 auixp.4 auvia.4 awi.4 axe.4 az.4 azalia.4 \
bce.4 bcw.4 bge.4 bha.4 \
bio.4 bktr.4 bmtphy.4 bnx.4 boca.4 bpf.4 brgphy.4 bridge.4 cac.4 \
- cardbus.4 carp.4 ccd.4 cd.4 cdce.4 cfxga.4 ch.4 ciphy.4 ciss.4 \
- clcs.4 clct.4 cmpci.4 cnw.4 \
+ cardbus.4 carp.4 ccd.4 cd.4 cdce.4 cdcef.4 cfxga.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 dpt.4 \
drum.4 eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 \
emu.4 enc.4 ep.4 epic.4 esa.4 eso.4 ess.4 exphy.4 \
diff --git a/share/man/man4/cdcef.4 b/share/man/man4/cdcef.4
new file mode 100644
index 00000000000..82348e92e9c
--- /dev/null
+++ b/share/man/man4/cdcef.4
@@ -0,0 +1,50 @@
+.\" $OpenBSD: cdcef.4,v 1.1 2006/11/27 15:49:31 uwe Exp $
+.\"
+.\" Uwe Stuehler, 2006. Public Domain.
+.\"
+.Dd November 27, 2006
+.Dt CDCEF 4
+.Os
+.Sh NAME
+.Nm cdcef
+.Nd USB Communication Device Class Ethernet function
+.Sh SYNOPSIS
+.Cd "cdcef* at usbf?"
+.Sh DESCRIPTION
+The
+.Nm
+driver implements the USB Communication Device Class (CDC) Ethernet
+Emulation Model (EEM) to provide support for USB Host-to-Host bridges.
+.Pp
+The USB bridge appears as a regular network interface on both sides,
+transporting Ethernet frames.
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr cdce 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr usbf 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Rs
+.%T "Universal Serial Bus Class Definitions for Communication Devices"
+.%O http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
+.Re
+.Rs
+.%T "CDC Subclass Specification for Ethernet Emulation Model Devices"
+.%O http://www.usb.org/developers/devclass_docs/CDC_EEM10.pdf
+.Re
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.1 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Uwe Stuehler Aq uwe@openbsd.org .