BSD 4_4_Lite1 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 7781786..906f8c2 100644 (file)
--- a/usr/src/sbin/route/route.8
+++ b/usr/src/sbin/route/route.8
@@ -1,156 +1,324 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"    @(#)route.8     6.2 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH ROUTE 8C ""
-.UC 5
-.SH NAME
-route \- manually manipulate the routing tables
-.SH SYNOPSIS
-.B /etc/route
-[
-.B \-f
-] [
-.B \-n
-] [
-.I command args
-]
-.SH DESCRIPTION
-.I Route
-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),
+.\" 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.
+.\"
+.\"     @(#)route.8    8.3 (Berkeley) 3/19/94
+.\"
+.Dd March 19, 1994
+.Dt ROUTE 8
+.Os BSD 4.4
+.Sh NAME
+.Nm route
+.Nd manually manipulate the routing tables.
+.Sh SYNOPSIS
+.Nm route
+.Op Fl nqv
+.Ar command
+.Oo
+.Op Ar modifiers
+.Ar args
+.Oc
+.Sh DESCRIPTION
+.Nm Route
+is a utility used to manually manipulate the network
+routing tables.  It normally is not needed, as a
+system routing table management daemon such as
+.Xr routed 8 ,

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

-.PP
-.I Route
-accepts two commands:
-.IR add ,
-to add a route, and
-.IR delete ,
-to delete a route.
-.PP
-All commands have the following syntax:
-.PP
-.ti +0.25i
-.B /etc/route 
-.I command
-[
-.B net
-|
-.B host
-]
-.I destination gateway
-[
-.I metric
-]
-.PP
+.Pp
+The
+.Nm route :
+utility supports a limited number of general options,
+but a rich command language, enabling the user to specify
+any arbitrary request that could be delivered via the
+programmatic interface discussed in 
+.Xr route 4 .
+.Pp
+.Bl -tag -width Ds
+.It Fl n
+Bypasses attempts to print host and network names symbolically
+when reporting actions.  (The process of translating between symbolic
+names and numerical equivalents can be quite time consuming, and
+may require correct operation of the network; thus it may be expedient
+to forgo this, especially when attempting to repair networking operations),
+.It Fl v
+(verbose) Print additional details.
+.It Fl q
+Suppress all output.
+.El
+.Pp
+The
+.Nm route :
+utility provides six commands:
+.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 partitionings.
+.El
+.Pp
+The monitor command has the syntax
+.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
+If the 
+.Cm flush
+command is specified, 
+.Nm route
+will ``flush'' the routing tables of all gateway entries.
+When the address family may is specified by any of the
+.Fl osi ,
+.Fl xns ,
+or
+.Fl inet
+modifiers, only routes having destinations with addresses in the
+delineated family will be deleted.
+.Pp
+The other commands have the following syntax:
+.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
-is the next-hop gateway to which packets should be addressed, and
-.I metric
-is a count indicating the number of hops to
-the
-.IR destination .
-The metric is required for
-.I add
-commands; it must be zero if the destination is on a directly-attached network,
-and nonzero if the route utilizes one or more gateways.
-If adding a route with metric 0,
-the gateway given is the address of this host on the common network,
-indicating the interface to be used for transmission.
-Routes to a particular host are distinguished from those to
-a network by interpreting the Internet address associated with
-.IR destination .
-The optional keywords
-.B net
+.Ar gateway
+is the next-hop intermediary via which packets should be routed.
+Routes to a particular host may be distinguished from those to
+a network by interpreting the Internet address specified as the
+.Ar destination argument.
+The optional modifiers
+.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 to a destination connected
-via a gateway, the 
-.I metric
-should be greater than 0.  All symbolic names specified for a
-.I destination 
+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 destination is directly reachable
+via an interface requiring
+no intermediary system to act as a gateway, the 
+.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.
+.Pp
+The optional modifiers
+.Fl xns ,
+.Fl osi ,
+and
+.Fl link 
+specify that all subsequent addresses are in the
+.Tn XNS
+.Tn OSI
+address families,
+or are specified as link-level addresses,
+and the names must be numeric specifications rather than
+symbolic names.
+.Pp
+The optional
+.Fl netmask
+qualifier is intended
+to achieve the effect of an
+.Tn OSI
+.Tn ESIS
+redirect with the netmask option,
+or to manually add subnet routes with
+netmasks different from that of the implied network interface
+(as would otherwise be communicated using the OSPF or ISIS routing protocols).
+One specifies an additional ensuing address parameter
+(to be interpreted as a network mask).
+The implicit network mask generated in the AF_INET case
+can be overridden by making sure this option follows the destination parameter.
+.Pp
+Routes have associated flags which influence operation of the protocols
+when sending to destinations matched by the routes.
+These flags may be set (or sometimes cleared)
+by indicating the following corresponding modifiers:
+.Bd -literal
+-cloning   RTF_CLONING    - generates a new route on use
+-xresolve  RTF_XRESOLVE   - emit mesg on use (for external lookup)
+-iface    ~RTF_GATEWAY    - destination is directly reachable
+-static    RTF_STATIC     - manually added route
+-nostatic ~RTF_STATIC     - pretend route added by kernel or daemon
+-reject    RTF_REJECT     - emit an ICMP unreachable when matched
+-blackhole RTF_BLACKHOLE  - silently discard pkts (during updates)
+-proto1    RTF_PROTO1     - set protocol specific routing flag #1
+-proto2    RTF_PROTO2     - set protocol specific routing flag #2
+-llinfo    RTF_LLINFO     - validly translates proto addr to link addr
+.Ed
+.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 quantities maintained in the routing entry
+by transport level protocols, such as TCP or TP4.
+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
+.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
-uses a raw socket and the SIOCADDRT and SIOCDELRT
-.IR ioctl 's
-to do its work.  As such, only the super-user may modify
+.Pp
+.Nm Route
+uses a routing socket and the new message types
+RTM_ADD,
+RTM_DELETE,
+RTM_GET,
+and
+RTM_CHANGE.
+As such, only the super-user may modify

 the routing tables.
 the routing tables.

-.PP
-If the 
-.B \-f
-option is specified, 
-.I route
-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
+.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"
-intro(4N),
-routed(8C),
-XNSrouted(8C)
+.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.