macro and text revision (-mdoc version 3)

[unix-history] / usr / src / share / man / man4 / esis.4

diff --git a/usr/src/share/man/man4/esis.4 b/usr/src/share/man/man4/esis.4
index 39dd97d..2195b03 100644 (file)
--- a/usr/src/share/man/man4/esis.4
+++ b/usr/src/share/man/man4/esis.4
@@ -1,101 +1,194 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)esis.4      6.1 (Berkeley) %G%
+.\"     @(#)esis.4     6.2 (Berkeley) %G%

 .\"
 .\"

-.TH TP 4 ""
-.UC 5
-.SH NAME
-es-is \- End System to Intermediate System Routing Protocol
-.SH SYNOPSIS
-.B "pseudo-device ether"
-.SH DESCRIPTION
-The ES-IS routing protocol is used to dynamically map between ISO NSAP
-addresses and ISO SNPA addresses; to permit End and Intermediate Systems
+.Dd 
+.Dt ESIS 4
+.Os
+.Sh NAME
+.Nm es-is
+.Nd End System to Intermediate System Routing Protocol
+.Sh SYNOPSIS
+.Sy pseudo-device
+.Nm ether
+.Sh DESCRIPTION
+The
+.Nm ES-IS
+routing protocol is used to dynamically map between
+.Tn ISO NSAP
+addresses and
+.Tn ISO SNPA
+addresses; to permit End and Intermediate Systems

 to learn of each other's existence; and to allow Intermediate Systems
 to inform End Systems of (potentially) better routes to use when 
 to learn of each other's existence; and to allow Intermediate Systems
 to inform End Systems of (potentially) better routes to use when 

-forwarding NPDUs to a particular destination.
-.PP
-The mapping between NSAP addresses and SNPA addresses is accomplished by
-transmitting hello PDUs between the cooperating Systems. These PDUs
-are transmitted whenever the \fIconfiguration\fR timer expires.
-When a hello PDU is received, the SNPA
+forwarding
+.Tn NPDU Ns s
+to a particular destination.
+.Pp
+The mapping between
+.Tn NSAP
+addresses and
+.Tn SNPA
+addresses is accomplished by
+transmitting hello
+.Tn PDU Ns s
+between the cooperating Systems. These
+.Tn PDU Ns s
+are transmitted whenever the
+.Em configuration
+timer expires.
+When a hello
+.Tn PDU
+is received, the
+.Tn SNPA

 address that it conveys is stored in the routing table for as long as the
 address that it conveys is stored in the routing table for as long as the

-\fIholding time\fR in the PDU suggests. The default \fIholding time\fR
-(120 seconds) placed in the hello PDU, the configuration timer value,
+.Em holding time
+in the
+.Tn PDU
+suggests. The default
+.Em holding time
+(120 seconds) placed in the hello
+.Tn PDU ,
+the configuration timer value,

 and the system type (End System or Intermediate System) may be changed by
 and the system type (End System or Intermediate System) may be changed by

-issuing an SIOCSSTYPE ioctl(), which is defined in /sys/netiso/iso_snpac.h.
-.PP
+issuing an
+.Dv SIOCSSTYPE
+.Xr ioctl 2 ,
+which is defined in
+.Pa /sys/netiso/iso_snpac.h.
+.Pp

 The protocol behaves differently depending on whether the System is
 configured as an End System or an Intermediate System.
 The protocol behaves differently depending on whether the System is
 configured as an End System or an Intermediate System.

-.SH "END SYSTEM OPERATION"
+.Sh END SYSTEM OPERATION

 When an interface requests a mapping for an address not in the cache,
 When an interface requests a mapping for an address not in the cache,

-the SNPA of any known Intermediate System is returned. If an Intermediate
-System is not known, then the \fIall end systems\fR multicast address
+the
+.Tn SNPA
+of any known Intermediate System is returned. If an Intermediate
+System is not known, then the
+.Em all end systems
+multicast address

 is returned. It is assumed that the intended recipient of the NPDU will
 is returned. It is assumed that the intended recipient of the NPDU will

-immediately transmit a hello PDU back to the originator of the NPDU.
-.PP
-If an NPDU is forwarded by the End System, a redirect PDU will not be
+immediately transmit a hello
+.Tn PDU
+back to the originator of the
+.Tn NPDU .
+.Pp
+If an
+.Tn NPDU
+is forwarded by the End System, a redirect
+.Tn PDU
+will not be

 generated.
 generated.

-However, redirect PDUs received will be processed. This processing
+However, redirect
+.Tn PDU Ns s
+received will be processed. This processing

 consists of adding an entry in the routing table. If the
 redirect is towards an Intermediate System, then an entry is made in the
 routing table as well.
 The entry in the routing table will may mark the
 consists of adding an entry in the routing table. If the
 redirect is towards an Intermediate System, then an entry is made in the
 routing table as well.
 The entry in the routing table will may mark the

-NSAP address contained in the redirect PDU as the gateway for the destination
+.Tn NSAP
+address contained in the redirect
+.Tn PDU
+as the gateway for the destination

 system (if an NET is supplied), or will create a route with
 the NSAP address as the
 system (if an NET is supplied), or will create a route with
 the NSAP address as the

-destination and the SNPA address (embodied as a link-level sockaddr) as the
+destination and the
+.Tn SNPA
+address (embodied as a link-level sockaddr) as the

 gateway.
 gateway.

-.PP
+.Pp

 If the System is configured as an End System, it will report all the
 If the System is configured as an End System, it will report all the

-NSAPs that have been configured using the ifconfig command, and no others.
-It is possible to have more than one NSAP assigned to a given interface,
-and it is also possible to have the same NSAP assigned to multiple
+.Tn NSAP Ns s
+that have been configured using the ifconfig command, and no others.
+It is possible to have more than one
+.Tn NSAP
+assigned to a given interface,
+and it is also possible to have the same
+.Tn NSAP
+assigned to multiple

 interfaces.
 interfaces.

-However, any NSAP containing an NSEL that is consistent with the
+However, any
+.Tn NSAP
+containing an NSEL that is consistent with the

 nsellength option (default one) of any interface will be accepted as
 nsellength option (default one) of any interface will be accepted as

-an NSAP for this System.
-.SH "INTERMEDIATE SYSTEM OPERATION"
+an
+.Tn NSAP
+for this System.
+.Sh INTERMEDIATE SYSTEM OPERATION

 When an interface requests a mapping for an address not in the routing table,
 an error is returned.
 When an interface requests a mapping for an address not in the routing table,
 an error is returned.

-.PP
-When an NPDU is forwarded out on the same interface that the NPDU arrived upon,
-a redirect PDU is generated.
-.SH "MANUAL ROUTING TABLE MODIFICATION"
-.PP
-To facilitate communications with systems which do not use ES-IS,
+.Pp
+When an
+.Tn NPDU
+is forwarded out on the same interface that the
+.Tn NPDU
+arrived upon,
+a redirect
+.Tn PDU
+is generated.
+.Sh MANUAL ROUTING TABLE MODIFICATION
+.Pp
+To facilitate communications with systems which do not use
+.Nm ES-IS,

 one may add a route whose destination is a sockaddr_iso containing
 one may add a route whose destination is a sockaddr_iso containing

-the NSAP in question, and the gateway being a link-level sockaddr,
+the
+.Tn NSAP
+in question, and the gateway being a link-level sockaddr,

 either by writing a special purpose program, or using the
 either by writing a special purpose program, or using the

-.IR route (8)
+.Xr route 8

 command e.g.:
 command e.g.:

-.nf
-
-       route add -iface -osi 49.0.4.8.0.2b.b.83.bf -link qe0:8.0.2b.b.83.bf
-.fi
-.PP
+.Bd -literal
+route add -iface -osi 49.0.4.8.0.2b.b.83.bf \
+       -link qe0:8.0.2b.b.83.bf
+.Ed
+.Pp

 If the
 System is configured as an End System and has a single network interface
 which does not support multicast reception,
 If the
 System is configured as an End System and has a single network interface
 which does not support multicast reception,

-it is necessary to manually configure the location of an IS,
+it is necessary to manually configure the location of an
+.Tn IS ,

 using the route command in a similar way.
 using the route command in a similar way.

-There, the destination address should be ``default'' (spelled 
-out literally as 7 ascii characters), and the gateway should be
-once again be a link-level sockaddr specifying the SNPA of the IS.
-.SH SEE ALSO
-un(4), iso(4F), route(8), ifconfig(8C)
-.br
-``End system to Intermediate system routing exchange protocol
-for use in conjunction with the Protocol for providing the 
-connectionless-mode network service'' (ISO 9542).
-.SH BUGS
-Redirect PDUs do not contain options from the forwarded NPDU which generated
+There, the destination address should be
+.Dq default
+(spelled 
+out literally as 7
+.Tn ASCII
+characters), and the gateway should be
+once again be a link-level sockaddr specifying the
+.Tn SNPA
+of the
+.Tn IS .
+.Sh SEE ALSO
+.Xr un 4 ,
+.Xr iso 4 ,
+.Xr route 8 ,
+.Xr ifconfig 8
+.Rs
+.%T "End system to Intermediate system routing exchange protocol for use in conjunction with the Protocol for providing the connectionless-mode network service"
+.%R ISO
+.%N 9542
+.Re
+.Sh HISTORY
+The
+.Nm
+protocol implementation
+.Ud
+.Sh BUGS
+Redirect
+.Tn PDU Ns s
+do not contain options from the forwarded
+.Tn NPDU
+which generated

 the redirect. The multicast address used on the 802.3 network is taken from
 the redirect. The multicast address used on the 802.3 network is taken from

-the NBS December 1987 agreements. This multicast address is not compatible
+the
+.Tn NBS
+December 1987 agreements. This multicast address is not compatible

 with the 802.5 (Token Ring) multicast addresses format. Therefore, broadcast
 addresses are used on the 802.5 subnetwork.
 Researchers at the University of Wisconsin are constructing an implementation
 with the 802.5 (Token Ring) multicast addresses format. Therefore, broadcast
 addresses are used on the 802.5 subnetwork.
 Researchers at the University of Wisconsin are constructing an implementation

-of the IS-IS routing protocol.
+of the
+.Tn IS-IS
+routing protocol.