BSD 4_3_Net_2 release

[unix-history] / usr / src / sbin / route / route.8

diff --git a/usr/src/sbin/route/route.8 b/usr/src/sbin/route/route.8
index 65a9f9d..db11bea 100644 (file)
--- a/usr/src/sbin/route/route.8
+++ b/usr/src/sbin/route/route.8
@@ -1,197 +1,297 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)route.8     6.5 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.

 .\"
 .\"

-.TH ROUTE 8 ""
-.UC 5
-.SH NAME
-route \- manually manipulate the routing tables (Interim)
-.SH SYNOPSIS
-.B /etc/route
-[
-.B \-n
-] [
-.B \-q
-] [
-.B \-v
-] [
-.B \-k
-.I vmunix
-]
-.I command
-[ [
-.I modifiers
-]
-.I args
-]
-.SH DESCRIPTION
-.I Route
+.\"     @(#)route.8    6.11 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt ROUTE 8
+.Os BSD 4.2
+.Sh NAME
+.Nm route
+.Nd manually manipulate the routing tables (Interim)
+.Sh SYNOPSIS
+.Nm route
+.Op Fl n
+.Op Fl q
+.Op Fl v
+.Ar command
+.Oo
+.Op Ar modifiers
+.Ar args
+.Oc
+.Sh DESCRIPTION
+.Nm Route

 is a program used to manually manipulate the network
 routing tables.  It normally is not needed, as the
 system routing table management daemon,
 is a program used to manually manipulate the network
 routing tables.  It normally is not needed, as the
 system routing table management daemon,

-.IR routed (8C),
+.Xr routed 8 ,

 should tend to this task.
 should tend to this task.

-.PP
-.I Route
-accepts five commands:
-.IR add ,
-to add a route,
-.IR flush ,
-to remove all routes,
-.IR delete ,
-to delete a specific route,
-.IR change ,
-to changes aspects of a route (such as its gateway),
-and
-.IR monitor ,
-to report any changes to the routing information base,
+.Pp
+Options supported by
+.Nm route :
+.Pp
+.Bl -tag -width Ds
+.It Fl n
+Prevent attempts to print host and network names symbolically
+when reporting actions.
+.It Fl v
+(verbose) Print additional details.
+.It Fl q
+Suppress all output.
+.El
+.Pp
+Commands accepted by
+.Nm route :
+.Pp
+.Bl -tag -width Fl -compact
+.It Cm add
+Add a route.
+.It Cm flush
+Remove all routes.
+.It Cm delete
+Delete a specific route.
+.It Cm change
+Change aspects of a route (such as its gateway).
+.It Cm get
+Lookup and display the route for a destination.
+.It Cm monitor
+Continuously report any changes to the routing information base,

 routing lookup misses, or suspected network partionings.
 routing lookup misses, or suspected network partionings.

-.PP
+.El
+.Pp

 The monitor command has the syntax
 The monitor command has the syntax

-.ti +0.25i
-.B route 
-[
-.I -n 
-]
-.I monitor
-.PP
+.Pp
+.Bd -filled -offset indent -compact
+.Nm route Op Fl n
+.Cm monitor
+.Ed
+.Pp
+The flush command has the syntax
+.Pp
+.Bd -filled -offset indent -compact
+.Nm route Op Fl n
+.Cm flush
+.Op Ar family
+.Ed
+.Pp
+Where the address family may be specified by any of the
+.Fl osi ,
+.Fl xns ,
+or
+.Fl inet
+keywords.
+.Pp

 The other commands have the following syntax:
 The other commands have the following syntax:

-.PP
-.ti +0.25i
-.B route 
-[
-.I -n 
-]
-.I command
-[
-.B -net
-|
-.B -host
-]
-.I destination gateway
-[
-.I mask
-]
-.PP
+.Pp
+.Bd -filled -offset indent -compact
+.Nm route Op Fl n
+.Ar command
+.Op Fl net No \&| Fl host
+.Ar destination gateway
+.Ed
+.Pp

 where
 where

-.I destination
+.Ar destination

 is the destination host or network,
 is the destination host or network,

-.I gateway
+.Ar gateway

 is the next-hop gateway to which packets should be addressed.
 Routes to a particular host are distinguished from those to
 a network by interpreting the Internet address associated with
 is the next-hop gateway to which packets should be addressed.
 Routes to a particular host are distinguished from those to
 a network by interpreting the Internet address associated with

-.IR destination .
+.Ar destination .

 The optional keywords
 The optional keywords

-.B -net
+.Fl net

 and
 and

-.B -host
+.Fl host

 force the destination to be interpreted as a network or a host, respectively.
 Otherwise, if the 
 force the destination to be interpreted as a network or a host, respectively.
 Otherwise, if the 

-.I destination
-has a ``local address part'' of INADDR_ANY,
+.Ar destination
+has a ``local address part'' of
+INADDR_ANY ,

 or if the
 or if the

-.I destination
+.Ar destination

 is the symbolic name of a network, then the route is
 assumed to be to a network; otherwise, it is presumed to be a
 is the symbolic name of a network, then the route is
 assumed to be to a network; otherwise, it is presumed to be a

-route to a host.  If the route is via an interface rather than
+route to a host.
+.Pp
+For example,
+.Li 128.32
+is interpreted as
+.Fl host Li 128.0.0.32 ;
+.Li 128.32.130
+is interpreted as
+.Fl host Li 128.32.0.130 ;
+.Fl net Li 128.32
+is interpreted as
+.Li 128.32.0.0;
+and 
+.Fl net Li 128.32.130
+is interpreted as
+.Li 128.32.130.0 .
+.Pp
+If the route is via an interface rather than

 via a gateway, the 
 via a gateway, the 

-.I -interface
+.Fl interface

 modifier should be specified;
 the gateway given is the address of this host on the common network,
 indicating the interface to be used for transmission.
 modifier should be specified;
 the gateway given is the address of this host on the common network,
 indicating the interface to be used for transmission.

-.PP
+.Pp

 The optional modifiers
 The optional modifiers

-.I -xns,
+.Fl xns ,

 and
 and

-.I -osi
-specify that all subsequent addresses are in the XNS or OSI address families,
+.Fl osi
+specify that all subsequent addresses are in the
+.Tn XNS
+or
+.Tn OSI
+address families,

 and the names must be numeric specifications rather than
 symbolic names.
 and the names must be numeric specifications rather than
 symbolic names.

-For OSI addresses a third parameter is the address mask,
-as given in an ESIS redirect.
-(preceded by the -netmask modifier)
-.PP
+.Pp
+The optional
+.Fl netmask
+qualifier is intended
+to achieve the effect of an
+.Tn OSI
+.Tn ESIS
+redirect with the netmask option.
+One specifies an additional ensuing address parameter
+(to be interpreted as a network mask).
+The implicit network mask generated in the inet case
+can be overridden by making sure this option follows the destination parameter.
+.Pp
+The optional modifiers
+.Fl rtt ,
+.Fl rttvar ,
+.Fl sendpipe ,
+.Fl recvpipe ,
+.Fl mtu ,
+.Fl hopcount ,
+.Fl expire ,
+and
+.Fl ssthresh
+provide initial values to metrics maintained in the routing entry.
+These may be individually locked by preceding each such modifier to
+be locked by
+the
+.Fl lock
+meta-modifier, or one can 
+specify that all ensuing metrics may be locked by the
+.Fl lockrest
+meta-modifier.
+.Pp
+In a
+.Cm change
+or
+.Cm add
+command where the destination and gateway are not sufficient to specify
+the route (as in the
+.Tn ISO
+case where several interfaces may have the
+same address), the
+.Fl ifp
+or
+.Fl ifa
+modifiers may be used to determine the interface or interface address.
+.Pp

 All symbolic names specified for a
 All symbolic names specified for a

-.I destination 
+.Ar destination

 or 
 or 

-.I gateway
+.Ar gateway

 are looked up first as a host name using
 are looked up first as a host name using

-.IR gethostbyname (3N).
+.Xr gethostbyname 3 .

 If this lookup fails,
 If this lookup fails,

-.IR getnetbyname (3N)
+.Xr getnetbyname 3

 is then used to interpret the name as that of a network.
 is then used to interpret the name as that of a network.

-.PP
-.I Route
+.Pp
+.Nm Route

 uses a routing socket and the new message types
 uses a routing socket and the new message types

-RTM_ADD and RTM_DELETE.
+RTM_ADD,
+RTM_DELETE,
+RTM_GET,
+and
+RTM_CHANGE.

 As such, only the super-user may modify
 the routing tables.
 As such, only the super-user may modify
 the routing tables.

-.PP
+.Pp

 If the 
 If the 

-.B flush
+.Cm flush

 command is specified, 
 command is specified, 

-.I route
+.Nm route

 will ``flush'' the routing tables of all gateway entries.
 will ``flush'' the routing tables of all gateway entries.

-If this is used in conjunction with one of the commands
-described above, the tables are flushed prior to the command's
-application.
-.PP
-The
-.B \-n
-option prevents attempts to print host and network names symbolically
-when reporting actions.
-.SH DIAGNOSTICS
-``\fBadd [ host | network ] %s: gateway %s flags %x\fP''
-.br
+One can choose to flush only those routes whose destinations
+are of a given address family, by specifying an optional keyword
+describing which address family.
+.Sh DIAGNOSTICS
+.Bl -tag -width Ds
+.It Sy "add [host \&| network ] %s: gateway %s flags %x"

 The specified route is being added to the tables.  The
 values printed are from the routing table entry supplied
 in the 
 The specified route is being added to the tables.  The
 values printed are from the routing table entry supplied
 in the 

-.I ioctl
+.Xr ioctl 2

 call.
 If the gateway address used was not the primary address of the gateway
 (the first one returned by
 call.
 If the gateway address used was not the primary address of the gateway
 (the first one returned by

-.IR gethostbyname ),
+.Xr gethostbyname 3 ) ,

 the gateway address is printed numerically as well as symbolically.
 the gateway address is printed numerically as well as symbolically.

-.PP
-``\fBdelete [ host | network ] %s: gateway %s flags %x\fP''
-.br
+.It Sy "delete [ host &| network ] %s: gateway %s flags %x" 

 As above, but when deleting an entry.
 As above, but when deleting an entry.

-.PP
-``\fB%s %s done\fP''
-.br
+.It Sy "%s %s done"

 When the 
 When the 

-.B \-f
-flag is specified, each routing table entry deleted
+.Cm flush
+command is specified, each routing table entry deleted

 is indicated with a message of this form.
 is indicated with a message of this form.

-.PP
-``\fBNetwork is unreachable\fP''
-.br
+.It Sy "Network is unreachable"

 An attempt to add a route failed because the gateway listed was not
 on a directly-connected network.
 The next-hop gateway must be given.
 An attempt to add a route failed because the gateway listed was not
 on a directly-connected network.
 The next-hop gateway must be given.

-.PP
-``\fBnot in table\fP''
-.br
+.It Sy "not in table"

 A delete operation was attempted for an entry which
 wasn't present in the tables.
 A delete operation was attempted for an entry which
 wasn't present in the tables.

-.PP
-``\fBrouting table overflow\fP''
-.br
+.It Sy "routing table overflow"

 An add operation was attempted, but the system was
 low on resources and was unable to allocate memory
 to create the new entry.
 An add operation was attempted, but the system was
 low on resources and was unable to allocate memory
 to create the new entry.

-.SH "SEE ALSO"
-netintro(4), routed(8), XNSrouted(8)
+.El
+.Sh SEE ALSO
+.Xr netintro 4 ,
+.Xr route 4 ,
+.Xr esis 4 ,
+.Xr routed 8 ,
+.Xr XNSrouted 8
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .
+.Sh BUGS
+The first paragraph may have slightly exaggerated
+.Xr routed Ns 's
+abilities.