Annotation of cci/usr/src/man/man8/route.8c, revision 1.1.1.1

1.1       root        1: .TH ROUTE 8C "5 May 1983"
                      2: .UC 4
                      3: .SH NAME
                      4: route \- manually manipulate the routing tables
                      5: .SH SYNOPSIS
                      6: .B /etc/route
                      7: [
                      8: .B \-f
                      9: ] [
                     10: .I command args
                     11: ]
                     12: .SH DESCRIPTION
                     13: .I Route
                     14: is a program used to manually manipulate the network
                     15: routing tables.  It normally is not needed, as the
                     16: system routing table management daemon,
                     17: .IR routed (8C),
                     18: should tend to this task.
                     19: .PP
                     20: .I Route
                     21: accepts three commands:
                     22: .IR add ,
                     23: to add a route;
                     24: .IR delete ,
                     25: to delete a route; and
                     26: .IR change ,
                     27: to modify an existing route.
                     28: .PP
                     29: All commands have the following syntax:
                     30: .PP
                     31: .ti +0.5i
                     32: .B /etc/route 
                     33: .I command
                     34: .B destination gateway
                     35: [
                     36: .B metric
                     37: ]
                     38: .PP
                     39: where
                     40: .I destination
                     41: is a host or network for which
                     42: the route is ``to'',
                     43: .I gateway
                     44: is the gateway to which packets should be addressed, and
                     45: .I metric
                     46: is an optional count indicating the number of hops to
                     47: the
                     48: .IR destination .
                     49: If no metric is specified, 
                     50: .I route
                     51: assumes a value of 0.
                     52: Routes to a particular host are distinguished from those to
                     53: a network by interpreting the Internet address associated with
                     54: .IR destination .
                     55: If the 
                     56: .I destination
                     57: has a ``local address part'' of INADDR_ANY, then the route is
                     58: assumed to be to a network; otherwise, it is presumed to be a
                     59: route to a host.  If the route is to a destination connected
                     60: via a gateway, the 
                     61: .I metric
                     62: should be greater than 0.  All symbolic names specified for a
                     63: .I destination 
                     64: or 
                     65: .I gateway
                     66: are looked up first in the host name database,
                     67: .IR hosts (5).
                     68: If this lookup fails, the name is then looked for
                     69: in the network name database,
                     70: .IR networks (5).
                     71: .PP
                     72: .I Route
                     73: uses a raw socket and the SIOCADDRT and SIOCDELRT
                     74: .IR ioctl 's
                     75: to do its work.  As such, only the super-user may modify
                     76: the routing tables.
                     77: .PP
                     78: If the 
                     79: .B \-f
                     80: option is specified, 
                     81: .I route
                     82: will ``flush'' the routing tables of all gateway entries.
                     83: If this is used in conjunction with one of the commands
                     84: described above, the tables are flushed prior to the command's
                     85: application.
                     86: .SH DIAGNOSTICS
                     87: .B ``add %s: gateway %s flags %x''
                     88: .br
                     89: The specified route is being added to the tables.  The
                     90: values printed are from the routing table entry supplied
                     91: in the 
                     92: .I ioctl
                     93: call.
                     94: .PP
                     95: .B ``delete %s: gateway %s flags %x''
                     96: .br
                     97: As above, but when deleting an entry.
                     98: .PP
                     99: .B ``%s %s done''
                    100: .br
                    101: When the 
                    102: .B \-f
                    103: flag is specified, each routing table entry deleted
                    104: is indicated with a message of this form.
                    105: .PP
                    106: .B  ``not in table''
                    107: .br
                    108: A delete operation was attempted for an entry which
                    109: wasn't present in the tables.
                    110: .PP
                    111: .B ``routing table overflow''
                    112: .br
                    113: An add operation was attempted, but the system was
                    114: low on resources and was unable to allocate memory
                    115: to create the new entry.
                    116: .SH "SEE ALSO"
                    117: intro(4N),
                    118: routed(8C)
                    119: .SH BUGS
                    120: The change operation is not implemented, one should add
                    121: the new route, then delete the old one.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.