diff options
| -rw-r--r-- | share/man/man4/Makefile | 8 | ||||
| -rw-r--r-- | share/man/man4/lmc.4 | 92 | ||||
| -rw-r--r-- | share/man/man4/sppp.4 | 218 |
3 files changed, 315 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 91160a0afaa..44b515e35bc 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,14 +1,16 @@ -# $OpenBSD: Makefile,v 1.63 1999/06/21 23:40:43 d Exp $ +# $OpenBSD: Makefile,v 1.64 1999/07/02 18:09:46 deraadt Exp $ # $NetBSD: Makefile,v 1.22.4.2 1996/07/18 00:51:10 jtc Exp $ MAN= atalk.4 audio.4 acd.4 adv.4 ahc.4 bpf.4 bridge.4 ccd.4 cd.4 ch.4 \ clnp.4 cltp.4 ddb.4 de.4 drum.4 eap.4 ec.4 ep.4 esis.4 exphy.4 fd.4 \ ffs_softupdates.4 fpa.4 fxp.4 icmp.4 icsphy.4 idp.4 ifmedia.4 imp.4 \ inet.4 inphy.4 ip.4 ipl.4 ipsec.4 isapnp.4 iso.4 isp.4 ksyms.4 lkm.4 \ - lo.4 lxtphy.4 midi.4 mii.4 mtdphy.4 mtio.4 mx.4 ncr.4 ne.4 netintro.4 \ + lmc.4 lo.4 lxtphy.4 \ + midi.4 mii.4 mtdphy.4 mtio.4 mx.4 ncr.4 ne.4 netintro.4 \ ns.4 nsip.4 nsphy.4 null.4 opl.4 options.4 pcmcia.4 pn.4 pty.4 \ qsphy.4 raid.4 random.4 rl.4 rln.4 rlphy.4 route.4 scsi.4 sd.4 sl.4 \ - sm.4 spp.4 sqphy.4 ss.4 st.4 sv.4 tb.4 tcp.4 termios.4 tl.4 tlphy.4 \ + sm.4 spp.4 sppp.4 sqphy.4 ss.4 st.4 sv.4 \ + tb.4 tcp.4 termios.4 tl.4 tlphy.4 \ tty.4 tp.4 tun.4 tx.4 udp.4 uk.4 unix.4 vnd.4 wb.4 we.4 wd.4 xl.4 ym.4 MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4 MLINKS+=netintro.4 networking.4 diff --git a/share/man/man4/lmc.4 b/share/man/man4/lmc.4 new file mode 100644 index 00000000000..e1ae964b82e --- /dev/null +++ b/share/man/man4/lmc.4 @@ -0,0 +1,92 @@ +.\" +.\" Copyright (c) 1999 Chris Cappuccio +.\" +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd July 1, 1999 +.Dt LMC 4 +.Os OpenBSD +.Sh NAME +.Nm lmc +.Nd +Lan Media Corporation SSI/HSSI/DS3 card device driver +.Sh SYNOPSIS +.Cd "lmc* at pci? dev ? function ?" +.Sh DESCRIPTION +The +.Nm +driver provides support for the Lan Media Corporation SSI, HSSI, and DS3 PCI +WAN adapters based on the DEC 21140 ethernet chip (with supporting +chips to handle the HDLC framing, and synchronous serial interface.) The intent +is to provide a synchronous serial link with HDLC framing at speeds +of up to 10Mbps (for the SSI card), 52Mbps (for the HSSI card) and DSX jacks +for 45Mbps operation without a CSU/DSU (DS3 card). +.Pp +The card will automatically use HDLC framing and defaults to external clock source. It should be configured as any point-to-point link. +.Pp +.Sh DIAGNOSTICS +.Bl -diag +.It "lmc%d: couldn't map interrupt" +A fatal initialization error has occurred. +.It "lmc%d: couldn't establish interrupt" +A fatal initialization error has occurred. +.It "lmc%d: enabling keepalive" +Cisco HDLC keepalive packets will be transmitted +.It "lmc%d: disabling keepalive" +Cisco HDLC keepalive packets will not be transmitted +.It "lmc%d: clock internal" +The card is using internal clocking for the line +.It "lmc%d: clock external" +The card is using external clocking for the line +.It "lmc%d: asserting DTR and RTS" +The card is sending DTR and RTS signals on the line +.It "lmc%d: deasserting DTR and RTS" +The card is not sending DTR and RTS signals on the line +.It "lmc%d: Abormal interrupt" +The card received an incomplete request +.It "lmc%d: tx_intr: failed to dequeue mbuf?!?" +Only available if compiled with LMC_DEBUG +.It "lmc%d: txput: tx not running" +Problem from tulip +Only available if compiled with LMC_DEBUG +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr netintro 4 , +.Xr sppp 4 , +.Xr ifconfig 8 +Lan Media Corporation has a web site with data, descriptions, and pictures +of their cards at www.lanmedia.com. +.Sh HISTORY +The +.Nm +device driver was first released from LMC to support their cards, +and was later included in NetBSD 1.4. +.Sh AUTHORS +The +.Nm +device driver was written by Michael Graff. It was initially +derived from Matt Thomas' +.Xr de 4 +driver. +The OpenBSD port and manual page are from Chris Cappuccio. diff --git a/share/man/man4/sppp.4 b/share/man/man4/sppp.4 new file mode 100644 index 00000000000..22b7348544a --- /dev/null +++ b/share/man/man4/sppp.4 @@ -0,0 +1,218 @@ +.\" +.\" Copyright (c) 1997 Joerg Wunsch +.\" +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $Id: sppp.4,v 1.1 1999/07/02 18:09:47 deraadt Exp $ +.\" +.Dd May 19, 1997 +.Dt SPPP 4 +.Os +.Sh NAME +.Nm sppp +.Nd point to point protocol network layer for synchronous lines +.Sh SYNOPSIS +.Cd "pseudo-device sppp" Op Ar count +.Sh DESCRIPTION +The +.Nm +network layer implements the state machine and the Link Control +Protocol (LCP) of the +.Em point to point protocol (PPP) +as described in RFC 1661. Note that this layer does not provide +network interfaces of its own, it is rather intended to be layered on +top of drivers providing a synchronuous point-to-point connection that +wish to run a PPP stack over it. The corresponding network interfaces +have to be provided by these hardware drivers. +.Pp +The +.Nm +layer provides three basic modes of operation. The default mode, +with no special flags to be set, is to create the PPP connection +(administrative +.Em Open +event to the LCP layer) as soon as the interface is taken up with the +.Xr ifconfig 8 +command. Taking the interface down again will terminate the LCP layer +and thus all other layers on top. The link will also terminate itself as +soon as no Network Control Protocol (NCP) is open anymore, indicating +that the lower layers are no longer needed. +.Pp +Setting the link-level flag +.Em link0 +with +.Xr ifconfig 8 +will cause the respective network interface to go into +.Em passive +mode. This means, the administrative +.Em Open +event to the LCP layer will be delayed until after the lower layers +signals an +.Em Up +event (rise of +.Dq carrier ) . +This can be used by lower layers to support +a dialin connection where the physical layer isn't available +immediately at startup, but only after some external event arrives. +Receipt of a +.Em Down +event from the lower layer will not take the interface completely down +in this case. +.Pp +Finally, setting the flag +.Em link1 +will cause the interface to operate in +.Em dial-on-demand +mode. This is also only useful if the lower layer supports the notion +of a carrier (like with an ISDN line). Upon configuring the +respective interface, it will delay the administrative +.Em Open +event to the LCP layer until either an outbound network packet +arrives, or until the lower layer signals an +.Em Up +event, indicating an inbound connection. As with passive mode, receipt +of a +.Em Down +event (loss of carrier) will not automatically take the interface down, +thus it remains available for further connections. +.Pp +The +.Nm +layer supports the +.Em debug +interface flag that can be set with +.Xr ifconfig 8 . +If this flag is set, the various control protocol packets being +exchanged as well as the option negotiation between both ends of the +link will be logged at level +.Dv LOG_DEBUG . +This can be helpful to examine configuration problems during the first +attempts to set up a new configuration. Without this flag being set, +only the major phase transitions will be logged at level +.Dv LOG_INFO . +.Pp +It is possible to leave the local interface IP address open for +negotiation by setting it to 0.0.0.0. This requires that the remote +peer can correctly supply a value for it based on the identity of the +caller, or on the remote address supplied by this side. Due to the +way the IPCP option negotiation works, this address is being supplied +late during the negotiation, which might cause the remote peer to make +wrong assumptions. +.Pp +In a similar spirit the remote address can be set to the magical +value 0.0.0.1 which means that we don't care what address the remote +side will use, as long as it is not 0.0.0.0. +This is useful if your ISP has several dial-in +servers. You can of course +.Ic route add something or other 0.0.0.1 +and it will do exactly what you would want it to. +.Pp +The PAP and CHAP authentication protocols as described in RFC 1334, +and RFC 1994 resp., are also implemented. Their parameters are being +controlled by the +.Xr spppcontrol 8 +utility. +.Sh DIAGNOSTICS +.Bl -diag +.It <ifname><ifnum>: <proto> illegal <event> in state <statename> +An event happened that should not happen for the current state +the respective control protocol is in. See RFC 1661 for a description +of the state automaton. +.It <ifname><ifnum>: loopback +The state automaton detected a line loopback (that is, it was talking +with itself). The interface will be temporarily disabled. +.It <ifname><ifnum>: up +The LCP layer is running again, after a line loopback had previously +been detected. +.It <ifname><ifnum>: down +The keepalive facility detected the line being unresponsive. +Keepalive must be explicitly requested by the lower layers in order to +take place. +.El +.Sh SEE ALSO +.Xr inet 4 , +.Xr intro 4 , +.Xr ppp 4 , +.Xr ifconfig 8 , +.Xr spppcontrol 8 +.Rs +.%A W. Simpson, Editor +.%T "The Point-to-Point Protocol (PPP)" +.%O RFC 1661 +.Re +.Rs +.%A G. McGregor +.%T "The PPP Internet Protocol Control Protocol (IPCP)" +.%O RFC 1332 +.Re +.Rs +.%A B. Lloyd, W. Simpson +.%T "PPP Authentication Protocols" +.%O RFC 1334 +.Re +.Rs +.%A W. Simpson +.%T "PPP Challenge Handshake Authentication Protocol (CHAP)" +.%O RFC 1994 +.Re +.Sh AUTHORS +The original implementation of +.Nm +was written in 1994 at Cronyx Ltd., Moscow by +.An Serge Vakulenko Aq vak@cronyx.ru . +.ie t J\(:org Wunsch +.el Joerg Wunsch +.Aq joerg_wunsch@uriah.heep.sax.de +rewrote a large part in 1997 in order +to fully implement the state machine as described in RFC 1661, so it +could also be used for dialup lines. He also wrote this man page. +Serge later on wrote a basic implementation for PAP and CHAP, which +served as the base for the current implementation, done again by +.ie t J\(:org Wunsch. +.el Joerg Wunsch. +.Sh BUGS +Many. +.Pp +Currently, only the +.Em IPCP +control protocol and +.Xr ip 4 +network protocol is supported. +.Pp +Negotiation loop avoidance is not fully implemented. If the negotiation +doesn't converge, this can cause an endless loop. +.Pp +The various parameters that should be adjustable per RFC 1661 are +currently hard-coded into the kernel, and should be made accessible +through +.Xr spppcontrol 8 . +.Pp +.Em Passive +mode has not been tested extensively. +.Pp +More NCPs should be implemented, as well as other control protocols +for authentication and link quality reporting. +.Pp +IPCP should support VJ header compression. +.Pp +Link-level compression protocols should be supported. |