1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)route.8 8.3 (Berkeley) 3/19/94 33.\" 34.Dd March 19, 1994 35.Dt ROUTE 8 36.Os BSD 4.4 37.Sh NAME 38.Nm route 39.Nd manually manipulate the routing tables. 40.Sh SYNOPSIS 41.Nm route 42.Op Fl nqv 43.Ar command 44.Oo 45.Op Ar modifiers 46.Ar args 47.Oc 48.Sh DESCRIPTION 49.Nm Route 50is a utility used to manually manipulate the network 51routing tables. It normally is not needed, as a 52system routing table management daemon such as 53.Xr routed 8 , 54should tend to this task. 55.Pp 56The 57.Nm route : 58utility supports a limited number of general options, 59but a rich command language, enabling the user to specify 60any arbitrary request that could be delivered via the 61programmatic interface discussed in 62.Xr route 4 . 63.Pp 64.Bl -tag -width Ds 65.It Fl n 66Bypasses attempts to print host and network names symbolically 67when reporting actions. (The process of translating between symbolic 68names and numerical equivalents can be quite time consuming, and 69may require correct operation of the network; thus it may be expedient 70to forgo this, especially when attempting to repair networking operations), 71.It Fl v 72(verbose) Print additional details. 73.It Fl q 74Suppress all output. 75.El 76.Pp 77The 78.Nm route : 79utility provides six commands: 80.Pp 81.Bl -tag -width Fl -compact 82.It Cm add 83Add a route. 84.It Cm flush 85Remove all routes. 86.It Cm delete 87Delete a specific route. 88.It Cm change 89Change aspects of a route (such as its gateway). 90.It Cm get 91Lookup and display the route for a destination. 92.It Cm monitor 93Continuously report any changes to the routing information base, 94routing lookup misses, or suspected network partitionings. 95.El 96.Pp 97The monitor command has the syntax 98.Pp 99.Bd -filled -offset indent -compact 100.Nm route Op Fl n 101.Cm monitor 102.Ed 103.Pp 104The flush command has the syntax 105.Pp 106.Bd -filled -offset indent -compact 107.Nm route Op Fl n 108.Cm flush 109.Op Ar family 110.Ed 111.Pp 112If the 113.Cm flush 114command is specified, 115.Nm route 116will ``flush'' the routing tables of all gateway entries. 117When the address family may is specified by any of the 118.Fl osi , 119.Fl xns , 120or 121.Fl inet 122modifiers, only routes having destinations with addresses in the 123delineated family will be deleted. 124.Pp 125The other commands have the following syntax: 126.Pp 127.Bd -filled -offset indent -compact 128.Nm route Op Fl n 129.Ar command 130.Op Fl net No \&| Fl host 131.Ar destination gateway 132.Ed 133.Pp 134where 135.Ar destination 136is the destination host or network, 137.Ar gateway 138is the next-hop intermediary via which packets should be routed. 139Routes to a particular host may be distinguished from those to 140a network by interpreting the Internet address specified as the 141.Ar destination argument. 142The optional modifiers 143.Fl net 144and 145.Fl host 146force the destination to be interpreted as a network or a host, respectively. 147Otherwise, if the 148.Ar destination 149has a ``local address part'' of 150INADDR_ANY , 151or if the 152.Ar destination 153is the symbolic name of a network, then the route is 154assumed to be to a network; otherwise, it is presumed to be a 155route to a host. 156.Pp 157For example, 158.Li 128.32 159is interpreted as 160.Fl host Li 128.0.0.32 ; 161.Li 128.32.130 162is interpreted as 163.Fl host Li 128.32.0.130 ; 164.Fl net Li 128.32 165is interpreted as 166.Li 128.32.0.0; 167and 168.Fl net Li 128.32.130 169is interpreted as 170.Li 128.32.130.0 . 171.Pp 172If the destination is directly reachable 173via an interface requiring 174no intermediary system to act as a gateway, the 175.Fl interface 176modifier should be specified; 177the gateway given is the address of this host on the common network, 178indicating the interface to be used for transmission. 179.Pp 180The optional modifiers 181.Fl xns , 182.Fl osi , 183and 184.Fl link 185specify that all subsequent addresses are in the 186.Tn XNS 187.Tn OSI 188address families, 189or are specified as link-level addresses, 190and the names must be numeric specifications rather than 191symbolic names. 192.Pp 193The optional 194.Fl netmask 195qualifier is intended 196to achieve the effect of an 197.Tn OSI 198.Tn ESIS 199redirect with the netmask option, 200or to manually add subnet routes with 201netmasks different from that of the implied network interface 202(as would otherwise be communicated using the OSPF or ISIS routing protocols). 203One specifies an additional ensuing address parameter 204(to be interpreted as a network mask). 205The implicit network mask generated in the AF_INET case 206can be overridden by making sure this option follows the destination parameter. 207.Pp 208Routes have associated flags which influence operation of the protocols 209when sending to destinations matched by the routes. 210These flags may be set (or sometimes cleared) 211by indicating the following corresponding modifiers: 212.Bd -literal 213-cloning RTF_CLONING - generates a new route on use 214-xresolve RTF_XRESOLVE - emit mesg on use (for external lookup) 215-iface ~RTF_GATEWAY - destination is directly reachable 216-static RTF_STATIC - manually added route 217-nostatic ~RTF_STATIC - pretend route added by kernel or daemon 218-reject RTF_REJECT - emit an ICMP unreachable when matched 219-blackhole RTF_BLACKHOLE - silently discard pkts (during updates) 220-proto1 RTF_PROTO1 - set protocol specific routing flag #1 221-proto2 RTF_PROTO2 - set protocol specific routing flag #2 222-llinfo RTF_LLINFO - validly translates proto addr to link addr 223.Ed 224.Pp 225The optional modifiers 226.Fl rtt , 227.Fl rttvar , 228.Fl sendpipe , 229.Fl recvpipe , 230.Fl mtu , 231.Fl hopcount , 232.Fl expire , 233and 234.Fl ssthresh 235provide initial values to quantities maintained in the routing entry 236by transport level protocols, such as TCP or TP4. 237These may be individually locked by preceding each such modifier to 238be locked by 239the 240.Fl lock 241meta-modifier, or one can 242specify that all ensuing metrics may be locked by the 243.Fl lockrest 244meta-modifier. 245.Pp 246In a 247.Cm change 248or 249.Cm add 250command where the destination and gateway are not sufficient to specify 251the route (as in the 252.Tn ISO 253case where several interfaces may have the 254same address), the 255.Fl ifp 256or 257.Fl ifa 258modifiers may be used to determine the interface or interface address. 259.Pp 260All symbolic names specified for a 261.Ar destination 262or 263.Ar gateway 264are looked up first as a host name using 265.Xr gethostbyname 3 . 266If this lookup fails, 267.Xr getnetbyname 3 268is then used to interpret the name as that of a network. 269.Pp 270.Nm Route 271uses a routing socket and the new message types 272RTM_ADD, 273RTM_DELETE, 274RTM_GET, 275and 276RTM_CHANGE. 277As such, only the super-user may modify 278the routing tables. 279.Sh DIAGNOSTICS 280.Bl -tag -width Ds 281.It Sy "add [host \&| network ] %s: gateway %s flags %x" 282The specified route is being added to the tables. The 283values printed are from the routing table entry supplied 284in the 285.Xr ioctl 2 286call. 287If the gateway address used was not the primary address of the gateway 288(the first one returned by 289.Xr gethostbyname 3 ) , 290the gateway address is printed numerically as well as symbolically. 291.It Sy "delete [ host &| network ] %s: gateway %s flags %x" 292As above, but when deleting an entry. 293.It Sy "%s %s done" 294When the 295.Cm flush 296command is specified, each routing table entry deleted 297is indicated with a message of this form. 298.It Sy "Network is unreachable" 299An attempt to add a route failed because the gateway listed was not 300on a directly-connected network. 301The next-hop gateway must be given. 302.It Sy "not in table" 303A delete operation was attempted for an entry which 304wasn't present in the tables. 305.It Sy "routing table overflow" 306An add operation was attempted, but the system was 307low on resources and was unable to allocate memory 308to create the new entry. 309.El 310.Sh SEE ALSO 311.Xr netintro 4 , 312.Xr route 4 , 313.Xr esis 4 , 314.Xr routed 8 , 315.Xr XNSrouted 8 316.Sh HISTORY 317The 318.Nm 319command appeared in 320.Bx 4.2 . 321.Sh BUGS 322The first paragraph may have slightly exaggerated 323.Xr routed Ns 's 324abilities. 325