Return to route.8 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / sbin / route

Annotation of 43BSDReno/sbin/route/route.8, revision 1.1

1.1     ! root        1: .\" Copyright (c) 1983 The Regents of the University of California.
        !             2: .\" All rights reserved.
        !             3: .\"
        !             4: .\" Redistribution and use in source and binary forms are permitted provided
        !             5: .\" that: (1) source distributions retain this entire copyright notice and
        !             6: .\" comment, and (2) distributions including binaries display the following
        !             7: .\" acknowledgement:  ``This product includes software developed by the
        !             8: .\" University of California, Berkeley and its contributors'' in the
        !             9: .\" documentation or other materials provided with the distribution and in
        !            10: .\" all advertising materials mentioning features or use of this software.
        !            11: .\" Neither the name of the University nor the names of its contributors may
        !            12: .\" be used to endorse or promote products derived from this software without
        !            13: .\" specific prior written permission.
        !            14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
        !            15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
        !            16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
        !            17: .\"
        !            18: .\"    @(#)route.8     6.8 (Berkeley) 6/24/90
        !            19: .\"
        !            20: .TH ROUTE 8 "June 24, 1990"
        !            21: .UC 5
        !            22: .SH NAME
        !            23: route \- manually manipulate the routing tables (Interim)
        !            24: .SH SYNOPSIS
        !            25: .B route
        !            26: [
        !            27: .B \-n
        !            28: ] [
        !            29: .B \-q
        !            30: ] [
        !            31: .B \-v
        !            32: ]
        !            33: .I command
        !            34: [ [
        !            35: .I modifiers
        !            36: ]
        !            37: .I args
        !            38: ]
        !            39: .SH DESCRIPTION
        !            40: .I Route
        !            41: is a program used to manually manipulate the network
        !            42: routing tables.  It normally is not needed, as the
        !            43: system routing table management daemon,
        !            44: .IR routed (8C),
        !            45: should tend to this task.
        !            46: .PP
        !            47: .I Route
        !            48: accepts five commands:
        !            49: .IR add ,
        !            50: to add a route,
        !            51: .IR flush ,
        !            52: to remove all routes,
        !            53: .IR delete ,
        !            54: to delete a specific route,
        !            55: .IR change ,
        !            56: to changes aspects of a route (such as its gateway),
        !            57: and
        !            58: .IR monitor ,
        !            59: to report any changes to the routing information base,
        !            60: routing lookup misses, or suspected network partionings.
        !            61: .PP
        !            62: The monitor command has the syntax
        !            63: .ti +0.25i
        !            64: .B route 
        !            65: [
        !            66: .B -n 
        !            67: ]
        !            68: .B monitor
        !            69: .PP
        !            70: The flush command has the syntax
        !            71: .ti +0.25i
        !            72: .B route
        !            73: [
        !            74: .B -n
        !            75: ]
        !            76: [
        !            77: .B -n
        !            78: ]
        !            79: .B flush
        !            80: [
        !            81: .I family
        !            82: ]
        !            83: .PP
        !            84: where the address family may be specified by any of the
        !            85: .BR -osi ,
        !            86: .BR -xns ,
        !            87: or
        !            88: .B -inet
        !            89: keywords.
        !            90: .PP
        !            91: The other commands have the following syntax:
        !            92: .PP
        !            93: .ti +0.25i
        !            94: .B route 
        !            95: [
        !            96: .I -n 
        !            97: ]
        !            98: .I command
        !            99: [
        !           100: .B -net
        !           101: |
        !           102: .B -host
        !           103: ]
        !           104: .I destination gateway
        !           105: .PP
        !           106: where
        !           107: .I destination
        !           108: is the destination host or network,
        !           109: .I gateway
        !           110: is the next-hop gateway to which packets should be addressed.
        !           111: Routes to a particular host are distinguished from those to
        !           112: a network by interpreting the Internet address associated with
        !           113: .IR destination .
        !           114: The optional keywords
        !           115: .B -net
        !           116: and
        !           117: .B -host
        !           118: force the destination to be interpreted as a network or a host, respectively.
        !           119: Otherwise, if the 
        !           120: .I destination
        !           121: has a ``local address part'' of INADDR_ANY,
        !           122: or if the
        !           123: .I destination
        !           124: is the symbolic name of a network, then the route is
        !           125: assumed to be to a network; otherwise, it is presumed to be a
        !           126: route to a host.
        !           127: .PP
        !           128: For example,
        !           129: 128.32 is interpreted as
        !           130: .I -host
        !           131: 128.0.0.32,
        !           132: 128.32.130 is interpreted as
        !           133: .I -host
        !           134: 128.32.0.130;
        !           135: .I -net 128.32
        !           136: is interpreted as
        !           137: 128.32.0.0,
        !           138: and 
        !           139: .I -net 128.32.130
        !           140: is interpreted as
        !           141: 128.32.130.0.
        !           142: .PP
        !           143: If the route is via an interface rather than
        !           144: via a gateway, the 
        !           145: .I -interface
        !           146: modifier should be specified;
        !           147: the gateway given is the address of this host on the common network,
        !           148: indicating the interface to be used for transmission.
        !           149: .PP
        !           150: The optional modifiers
        !           151: .I -xns,
        !           152: and
        !           153: .I -osi
        !           154: specify that all subsequent addresses are in the XNS or OSI address families,
        !           155: and the names must be numeric specifications rather than
        !           156: symbolic names.
        !           157: .PP
        !           158: The optional
        !           159: .I -netmask
        !           160: qualifier is intended
        !           161: to acheieve the effect of an OSI ESIS redirect with the netmask option.
        !           162: One specifies an additional ensuing address parameter
        !           163: (to be interpreted as a network mask).
        !           164: One can override the implicit network mask generated in the inet case
        !           165: by making sure this option follows the destination parameter.
        !           166: .PP
        !           167: The optional modifiers
        !           168: .IR -rtt ,
        !           169: .IR -rttvar ,
        !           170: .IR -sendpipe ,
        !           171: .IR -recvpipe ,
        !           172: .IR -mtu ,
        !           173: .IR -hopcount ,
        !           174: .IR -expire ,
        !           175: and
        !           176: .I -ssthresh 
        !           177: provide initial values to metrics maintained in the routing entry.
        !           178: These may be individually locked by preceding each such modifier to
        !           179: be locked by
        !           180: the
        !           181: .I -lock
        !           182: meta-modifier, or one can 
        !           183: specify that all ensuing metrics may be locked by the
        !           184: .I -lockrest
        !           185: meta-modifier.
        !           186: .PP
        !           187: All symbolic names specified for a
        !           188: .I destination 
        !           189: or 
        !           190: .I gateway
        !           191: are looked up first as a host name using
        !           192: .IR gethostbyname (3N).
        !           193: If this lookup fails,
        !           194: .IR getnetbyname (3N)
        !           195: is then used to interpret the name as that of a network.
        !           196: .PP
        !           197: .I Route
        !           198: uses a routing socket and the new message types
        !           199: RTM_ADD, RTM_DELETE, and RTM_CHANGE.
        !           200: As such, only the super-user may modify
        !           201: the routing tables.
        !           202: .PP
        !           203: If the 
        !           204: .B flush
        !           205: command is specified, 
        !           206: .I route
        !           207: will ``flush'' the routing tables of all gateway entries.
        !           208: One can choose to flush only those routes whose destinations
        !           209: are of a given address family, by specifying an optional keyword
        !           210: describing which address family.
        !           211: .PP
        !           212: The
        !           213: .B \-n
        !           214: option prevents attempts to print host and network names symbolically
        !           215: when reporting actions.
        !           216: The
        !           217: .B \-v
        !           218: option causes additional details to be printed.
        !           219: The
        !           220: .B \-q
        !           221: option supresses all output.
        !           222: .SH DIAGNOSTICS
        !           223: ``\fBadd [ host | network ] %s: gateway %s flags %x\fP''
        !           224: .br
        !           225: The specified route is being added to the tables.  The
        !           226: values printed are from the routing table entry supplied
        !           227: in the 
        !           228: .I ioctl
        !           229: call.
        !           230: If the gateway address used was not the primary address of the gateway
        !           231: (the first one returned by
        !           232: .IR gethostbyname ),
        !           233: the gateway address is printed numerically as well as symbolically.
        !           234: .PP
        !           235: ``\fBdelete [ host | network ] %s: gateway %s flags %x\fP''
        !           236: .br
        !           237: As above, but when deleting an entry.
        !           238: .PP
        !           239: ``\fB%s %s done\fP''
        !           240: .br
        !           241: When the 
        !           242: .B \-f
        !           243: flag is specified, each routing table entry deleted
        !           244: is indicated with a message of this form.
        !           245: .PP
        !           246: ``\fBNetwork is unreachable\fP''
        !           247: .br
        !           248: An attempt to add a route failed because the gateway listed was not
        !           249: on a directly-connected network.
        !           250: The next-hop gateway must be given.
        !           251: .PP
        !           252: ``\fBnot in table\fP''
        !           253: .br
        !           254: A delete operation was attempted for an entry which
        !           255: wasn't present in the tables.
        !           256: .PP
        !           257: ``\fBrouting table overflow\fP''
        !           258: .br
        !           259: An add operation was attempted, but the system was
        !           260: low on resources and was unable to allocate memory
        !           261: to create the new entry.
        !           262: .SH "SEE ALSO"
        !           263: netintro(4), routed(8), XNSrouted(8)

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