ROUTE(8)                  BSD System Manager's Manual                 ROUTE(8)

NAME
     route - manually manipulate the routing tables (Interim)

SYNOPSIS
     route [-n] [-q] [-v] command [[modifiers] args]

DESCRIPTION
     Route is a program used to manually manipulate the network routing ta-
     bles.  It normally is not needed, as the system routing table management
     daemon, routed(8),  should tend to this task.

     Options supported by route:

     -n      Prevent attempts to print host and network names symbolically
             when reporting actions.

     -v      (verbose) Print additional details.

     -q      Suppress all output.

     Commands accepted by route:

     add         Add a route.
     flush       Remove all routes.
     delete      Delete a specific route.
     change      Change aspects of a route (such as its gateway).
     get         Lookup and display the route for a destination.
     monitor     Continuously report any changes to the routing information
                 base, routing lookup misses, or suspected network partion-
                 ings.

     The monitor command has the syntax

           route [-n] monitor

     The flush command has the syntax

           route [-n] flush [family]

     Where the address family may be specified by any of the -osi, -xns, or
     -inet keywords.

     The other commands have the following syntax:

           route [-n] command [-net | -host] destination gateway

     where destination is the destination host or network, gateway is the
     next-hop gateway to which packets should be addressed.  Routes to a par-
     ticular host are distinguished from those to a network by interpreting
     the Internet address associated with destination. The optional keywords
     -net and -host force the destination to be interpreted as a network or a
     host, respectively.  Otherwise, if the destination has a ``local address
     part'' of INADDR_ANY , or if the 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 route to a host.

     For example, 128.32 is interpreted as -host 128.0.0.32; 128.32.130 is in-
     terpreted as -host 128.32.0.130; -net 128.32 is interpreted as
     128.32.0.0; and -net 128.32.130 is interpreted as 128.32.130.0.

     If the route is via an interface rather than via a gateway, the
     -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.

     The optional modifiers -xns, and -osi specify that all subsequent ad-
     dresses are in the XNS or OSI address families, and the names must be nu-
     meric specifications rather than symbolic names.

     The optional -netmask qualifier is intended to achieve the effect of an
     OSI ESIS redirect with the netmask option.  One specifies an additional
     ensuing address parameter (to be interpreted as a network mask).  The im-
     plicit network mask generated in the inet case can be overridden by mak-
     ing sure this option follows the destination parameter.

     The optional modifiers -rtt, -rttvar, -sendpipe, -recvpipe, -mtu,
     -hopcount, -expire, and -ssthresh provide initial values to metrics main-
     tained in the routing entry.  These may be individually locked by preced-
     ing each such modifier to be locked by the -lock meta-modifier, or one
     can specify that all ensuing metrics may be locked by the -lockrest meta-
     modifier.

     In a change or add command where the destination and gateway are not suf-
     ficient to specify the route (as in the ISO case where several interfaces
     may have the same address), the -ifp or -ifa modifiers may be used to de-
     termine the interface or interface address.

     All symbolic names specified for a destination or gateway are looked up
     first as a host name using gethostbyname(3).  If this lookup fails, get-
     netbyname(3) is then used to interpret the name as that of a network.

     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.

     If the flush command is specified, route will ``flush'' the routing ta-
     bles of all gateway entries.  One can choose to flush only those routes
     whose destinations are of a given address family, by specifying an op-
     tional keyword describing which address family.

DIAGNOSTICS
     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 ioctl(2)
             call.  If the gateway address used was not the primary address of
             the gateway (the first one returned by gethostbyname(3)),  the
             gateway address is printed numerically as well as symbolically.

     delete [ host &| network ] %s: gateway %s flags %x
             As above, but when deleting an entry.

     %s %s done
             When the flush command is specified, each routing table entry
             deleted is indicated with a message of this form.

     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.

     not in table
             A delete operation was attempted for an entry which wasn't pre-
             sent in the tables.

     routing table overflow
             An add operation was attempted, but the system was low on re-
             sources and was unable to allocate memory to create the new en-
             try.

SEE ALSO

     netintro(4),  route(4),  esis(4),  routed(8),  XNSrouted(8)

HISTORY
     The route command appeared in 4.2BSD.

BUGS
     The first paragraph may have slightly exaggerated routed's  abilities.

4.2 Berkeley Distribution       March 27, 1993                               3