summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorMartin Pieuchot <mpi@cvs.openbsd.org>2013-08-20 09:14:35 +0000
committerMartin Pieuchot <mpi@cvs.openbsd.org>2013-08-20 09:14:35 +0000
commit23558356ecf8868cf72b2130fa934d81f59c4fcb (patch)
tree7d0c56f50dca1b9eca2d1b0441dd9381c70c5288 /share/man
parent64348662cedb16b2da00028f667046ef5cfb517d (diff)
tedu netnatm and ueagle(4).
ok mikeb@, sthen@, tedu@ (implied), doc bits ok jmc@
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile5
-rw-r--r--share/man/man4/ueagle.4159
-rw-r--r--share/man/man4/usb.46
-rw-r--r--share/man/man7/hier.76
4 files changed, 6 insertions, 170 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 7395ec27ca6..d74bfab0bb5 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.552 2013/08/15 15:01:48 edd Exp $
+# $OpenBSD: Makefile,v 1.553 2013/08/20 09:14:10 mpi Exp $
MAN= aac.4 ac97.4 acphy.4 \
acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -57,8 +57,7 @@ MAN= aac.4 ac97.4 acphy.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 \
- ueagle.4 uftdi.4 ugen.4 uguru.4 uhci.4 uhid.4 uhidev.4 \
- uipaq.4 uk.4 ukbd.4 \
+ uftdi.4 ugen.4 uguru.4 uhci.4 uhid.4 uhidev.4 uipaq.4 uk.4 ukbd.4 \
ukphy.4 ulpt.4 umass.4 umbg.4 umct.4 umidi.4 umodem.4 ums.4 umsm.4 \
unix.4 uow.4 uoaklux.4 uoakrh.4 uoakv.4 \
upgt.4 upl.4 uplcom.4 ural.4 urio.4 url.4 urlphy.4 \
diff --git a/share/man/man4/ueagle.4 b/share/man/man4/ueagle.4
deleted file mode 100644
index 6b04ee8f63f..00000000000
--- a/share/man/man4/ueagle.4
+++ /dev/null
@@ -1,159 +0,0 @@
-.\" $OpenBSD: ueagle.4,v 1.18 2013/07/16 16:05:49 schwarze Exp $
-.\"
-.\" Copyright (c) 2003-2005
-.\" Damien Bergamini <damien.bergamini@free.fr>
-.\"
-.\" 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: July 16 2013 $
-.Dt UEAGLE 4
-.Os
-.Sh NAME
-.Nm ueagle
-.Nd Analog Devices Eagle ADSL modems
-.Sh SYNOPSIS
-.Cd "ueagle* at uhub? port ?"
-.Sh DESCRIPTION
-The
-.Nm
-driver provides support for USB ADSL modems based on the Analog Devices Eagle
-chipset (revision I, II and III).
-.Pp
-The
-.Nm
-driver can only manage a single ATM AAL5 virtual circuit.
-The segmentation and
-reassembly (SAR) of ATM cells is done by software.
-.Pp
-To achieve high rate downstream transfer with fast ADSL connections, the
-.Nm
-driver uses USB isochronous pipes instead of standard bulk pipes.
-.Pp
-To establish a permanent virtual circuit (PVC) with a peer,
-.Nm
-must be configured using the
-.Xr route 8
-command.
-A typical invocation is:
-.Bd -literal -offset 3n
-# route add -iface <Peer IP> -link if:encap.vpi.vci_hi.vci_lo
-.Ed
-.Pp
-The arguments to
-.Dq -link
-are as follows:
-.Pp
-.Bl -tag -width Ds -offset 3n -compact
-.It if
-Interface name.
-For example,
-.Dq ueagle0 .
-.Pp
-.It encap
-Type of encapsulation to use.
-Possible types are:
-.Pp
-.Bl -tag -width "AAL5 LLC/SNAPXX" -offset 3n -compact
-.It AAL5 VCMUX
-Use hex value 0x1.
-.It AAL5 LLC/SNAP
-Use hex value 0x3.
-.El
-.Pp
-.It vpi
-See ISP's recommended setting for this.
-All values specified in hex.
-.Pp
-.It vci_hi
-.It vci_lo
-See ISP's recommended setting for this.
-All values specified in hex.
-The VCI is specified as high_order_byte.low_order_byte.
-For example, a VCI of 35 would be specified as
-.Dq 0.23 .
-.El
-.Pp
-See also
-.Sx EXAMPLES
-below.
-.Sh HARDWARE
-The following modems should work:
-.Bl -column "ELSA MicroLink ADSL FUN USB" "Chip" -offset 6n
-.It Em "Modem" Ta Em "Chip"
-.It Li "Aethra Starmodem" Ta "Eagle II"
-.It Li "Allied Telesyn AT-AR215" Ta "Eagle I"
-.It Li "Arescom NDS1060" Ta "Eagle II"
-.It Li "Aztech 206U" Ta "Eagle II"
-.It Li "Comtrend CT-350" Ta "Eagle I"
-.It Li "Comtrend CT-361" Ta "Eagle I"
-.It Li "D-Link DSL-200I" Ta "Eagle I"
-.It Li "ECI B-FOCuS USB 150" Ta "Eagle II"
-.It Li "Elcon 111U" Ta "Eagle II"
-.It Li "Elcon 131U" Ta "Eagle II"
-.It Li "ELSA MicroLink ADSL FUN USB" Ta "Eagle I"
-.It Li "Huawei SmartAX MT810" Ta "Eagle II"
-.It Li "Sagem F@st 800" Ta "Eagle I"
-.It Li "Sagem F@st 800 PE/E2" Ta "Eagle II"
-.It Li "Sagem F@st 800 E3" Ta "Eagle III"
-.It Li "Sagem F@st 908" Ta "Eagle I"
-.It Li "Teledat 300 USB" Ta "Eagle I"
-.It Li "Telindus ND 220" Ta "Eagle II"
-.It Li "Telindus ND 220b" Ta "Eagle II"
-.It Li "US Robotics USR9000/2/3" Ta "Eagle I"
-.El
-.Sh FILES
-The adapter needs some firmware files, which are loaded on demand:
-.Pp
-.Bl -tag -width Ds -offset indent -compact
-.It /etc/firmware/ueagleI
-.It /etc/firmware/ueagleII
-.It /etc/firmware/ueagleIII
-.It /etc/firmware/ueagle-dsp
-.El
-.Pp
-These firmware files are not free because Analog Devices refuses to grant
-distribution rights.
-.Pp
-A prepackaged version of the firmware can be installed using
-.Xr fw_update 1 .
-.Sh EXAMPLES
-To establish a PVC (vpi=8, vci=35, vcmux) with host 192.168.1.2:
-.Bd -literal -offset indent
-# route add -iface 192.168.1.2 -link ueagle0:1.8.0.23
-.Ed
-.Pp
-To establish a PVC (vpi=0, vci=6, llc/snap) with host 192.168.1.3:
-.Bd -literal -offset indent
-# route add -iface 192.168.1.3 -link ueagle0:3.0.0.6
-.Ed
-.Sh SEE ALSO
-.Xr uhub 4 ,
-.Xr usb 4 ,
-.Xr route 8
-.Sh HISTORY
-The
-.Nm
-driver first appeared in
-.Ox 3.8 .
-.Sh AUTHORS
-The
-.Nm
-driver was written by
-.An Damien Bergamini Aq Mt damien@openbsd.org .
-.Sh CAVEATS
-The
-.Nm
-driver only supports ADSL over POTS.
-ADSL over ISDN is not supported.
-G.Lite modulation (aka splitterless) has never been tested and probably won't
-work.
diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4
index 27f57fd02b8..182b8c83ebc 100644
--- a/share/man/man4/usb.4
+++ b/share/man/man4/usb.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: usb.4,v 1.142 2013/08/15 15:01:48 edd Exp $
+.\" $OpenBSD: usb.4,v 1.143 2013/08/20 09:14:11 mpi Exp $
.\" $NetBSD: usb.4,v 1.15 1999/07/29 14:20:32 augustss Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
@@ -28,7 +28,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: August 15 2013 $
+.Dd $Mdocdate: August 20 2013 $
.Dt USB 4
.Os
.Sh NAME
@@ -135,8 +135,6 @@ MosChip MCS7730/7830/7832 10/100 USB Ethernet device
SMSC LAN95xx 10/100 USB Ethernet device
.It Xr udav 4
Davicom DM9601 10/100 USB Ethernet device
-.It Xr ueagle 4
-Analog Devices Eagle ADSL modems
.It Xr url 4
Realtek RTL8150L 10/100 USB Ethernet device
.It Xr urndis 4
diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7
index cc2fd4e3e43..f22d3295036 100644
--- a/share/man/man7/hier.7
+++ b/share/man/man7/hier.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: hier.7,v 1.109 2013/08/14 08:39:29 jmc Exp $
+.\" $OpenBSD: hier.7,v 1.110 2013/08/20 09:14:12 mpi Exp $
.\" $NetBSD: hier.7,v 1.7 1994/11/30 19:07:10 jtc Exp $
.\"
.\" Copyright (c) 1990, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)hier.7 8.1 (Berkeley) 6/5/93
.\"
-.Dd $Mdocdate: August 14 2013 $
+.Dd $Mdocdate: August 20 2013 $
.Dt HIER 7
.Os
.Sh NAME
@@ -262,8 +262,6 @@ C include files for Internet protocol version 6 (see
.Xr inet6 4 ) .
.It netmpls/
C include files for the MPLS protocol.
-.It netnatm/
-C include files for native mode ATM access.
.It nfs/
C include files for NFS (Network File System).
.It objc/