file_cmds: Fix install and COLORLS
[apple_cmds.git] / network_cmds / route.tproj / route.8
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 .\" $FreeBSD: src/sbin/route/route.8,v 1.17.2.7 2001/10/02 10:04:01 ru Exp $
34 .\"
35 .Dd June 8, 2001
36 .Dt ROUTE 8
37 .Os BSD 4.4
38 .Sh NAME
39 .Nm route
40 .Nd manually manipulate the routing tables
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl dnqtv
44 .Ar command
45 .Oo
46 .Op Ar modifiers
47 .Ar args
48 .Oc
49 .Sh DESCRIPTION
50 .Nm Route
51 is a utility used to manually manipulate the network
52 routing tables. It normally is not needed, as a
53 system routing table management daemon such as
54 .Xr routed 8 ,
55 should tend to this task.
56 .Pp
57 The
58 .Nm
59 utility supports a limited number of general options,
60 but a rich command language, enabling the user to specify
61 any arbitrary request that could be delivered via the
62 programmatic interface discussed in
63 .Xr route 4 .
64 .Pp
65 The following options are available:
66 .Bl -tag -width indent
67 .It Fl d
68 Run in debug-only mode, i.e., do not actually modify the routing table.
69 .It Fl n
70 Bypass attempts to print host and network names symbolically
71 when reporting actions. (The process of translating between symbolic
72 names and numerical equivalents can be quite time consuming, and
73 may require correct operation of the network; thus it may be expedient
74 to forget this, especially when attempting to repair networking operations).
75 .It Fl t
76 Run in test-only mode.
77 .Pa /dev/null
78 is used instead of a socket.
79 .It Fl v
80 (verbose) Print additional details.
81 .It Fl q
82 Suppress all output.
83 .El
84 .Pp
85 The
86 .Nm
87 utility provides six commands:
88 .Pp
89 .Bl -tag -width Fl -compact
90 .It Cm add
91 Add a route.
92 .It Cm flush
93 Remove all routes.
94 .It Cm delete
95 Delete a specific route.
96 .It Cm change
97 Change aspects of a route (such as its gateway).
98 .It Cm get
99 Lookup and display the route for a destination.
100 .It Cm monitor
101 Continuously report any changes to the routing information base,
102 routing lookup misses, or suspected network partitionings.
103 .El
104 .Pp
105 The monitor command has the syntax:
106 .Pp
107 .Bd -ragged -offset indent -compact
108 .Nm
109 .Op Fl n
110 .Cm monitor
111 .Ed
112 .Pp
113 The flush command has the syntax:
114 .Pp
115 .Bd -ragged -offset indent -compact
116 .Nm
117 .Op Fl n
118 .Cm flush
119 .Op Ar family
120 .Ed
121 .Pp
122 If the
123 .Cm flush
124 command is specified,
125 .Nm
126 will ``flush'' the routing tables of all gateway entries.
127 When the address family may is specified by any of the
128 .Fl osi ,
129 .Fl xns ,
130 .Fl atalk ,
131 .Fl inet6 ,
132 or
133 .Fl inet
134 modifiers, only routes having destinations with addresses in the
135 delineated family will be deleted.
136 .Pp
137 The other commands have the following syntax:
138 .Pp
139 .Bd -ragged -offset indent -compact
140 .Nm
141 .Op Fl n
142 .Ar command
143 .Op Fl net No \&| Fl host
144 .Oo Fl ifscope
145 .Ar boundif
146 .Oc
147 .Ar destination gateway
148 .Op Ar netmask
149 .Ed
150 .Pp
151 where
152 .Ar destination
153 is the destination host or network,
154 .Ar gateway
155 is the next-hop intermediary via which packets should be routed.
156 Routes to a particular host may be distinguished from those to
157 a network by interpreting the Internet address specified as the
158 .Ar destination
159 argument.
160 The optional modifiers
161 .Fl net
162 and
163 .Fl host
164 force the destination to be interpreted as a network or a host, respectively.
165 Otherwise, if the
166 .Ar destination
167 has a
168 .Dq local address part
169 of
170 INADDR_ANY
171 .Pq Li 0.0.0.0 ,
172 or if the
173 .Ar destination
174 is the symbolic name of a network, then the route is
175 assumed to be to a network; otherwise, it is presumed to be a
176 route to a host.
177 Optionally, the
178 .Ar destination
179 could also be specified in the
180 .Ar net Ns / Ns Ar bits
181 format.
182 .Pp
183 For example,
184 .Li 128.32
185 is interpreted as
186 .Fl host Li 128.0.0.32 ;
187 .Li 128.32.130
188 is interpreted as
189 .Fl host Li 128.32.0.130 ;
190 .Fl net Li 128.32
191 is interpreted as
192 .Li 128.32.0.0;
193 .Fl net Li 128.32.130
194 is interpreted as
195 .Li 128.32.130.0;
196 and
197 .Li 192.168.64/20
198 is interpreted as
199 .Fl net Li 192.168.64 Fl netmask Li 255.255.240.0 .
200 .Pp
201 A
202 .Ar destination
203 of
204 .Ar default
205 is a synonym for
206 .Fl net Li 0.0.0.0 ,
207 which is the default route.
208 .Pp
209 If the destination is directly reachable
210 via an interface requiring
211 no intermediary system to act as a gateway, the
212 .Fl interface
213 modifier should be specified;
214 the gateway given is the address of this host on the common network,
215 indicating the interface to be used for transmission.
216 Alternately, if the interface is point to point the name of the interface
217 itself may be given, in which case the route remains valid even
218 if the local or remote addresses change.
219 .Pp
220 For AF_INET and AF_INET6, the
221 .Fl ifscope
222 modifier specifies the additional property of the route related to
223 the interface scope derived from interface
224 .Ar boundif .
225 Such property allows for the presence of multiple route entries with
226 the same destination, where each route is associated with a unique
227 interface. This modifier is required in order to manipulate route
228 entries marked with the RTF_IFSCOPE flag.
229 .Pp
230 The optional modifier
231 .Fl link
232 specify that all subsequent addresses
233 are specified as link-level addresses,
234 and the names must be numeric specifications rather than
235 symbolic names.
236 .Pp
237 The optional
238 .Fl netmask
239 modifier is intended
240 to achieve the effect of an
241 .Tn OSI
242 .Tn ESIS
243 redirect with the netmask option,
244 or to manually add subnet routes with
245 netmasks different from that of the implied network interface
246 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
247 One specifies an additional ensuing address parameter
248 (to be interpreted as a network mask).
249 The implicit network mask generated in the AF_INET case
250 can be overridden by making sure this option follows the destination parameter.
251 .Pp
252 For
253 .Dv AF_INET6 ,
254 the
255 .Fl prefixlen
256 qualifier
257 is available instead of the
258 .Fl mask
259 qualifier because non-continuous masks are not allowed in IPv6.
260 For example,
261 .Fl prefixlen Li 32
262 specifies network mask of
263 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
264 to be used.
265 The default value of prefixlen is 64 to get along with
266 the aggregatable address.
267 But 0 is assumed if
268 .Cm default
269 is specified.
270 Note that the qualifier works only for
271 .Dv AF_INET6
272 address family.
273 .Pp
274 Routes have associated flags which influence operation of the protocols
275 when sending to destinations matched by the routes.
276 These flags may be set (or sometimes cleared)
277 by indicating the following corresponding modifiers:
278 .Bd -literal
279 -cloning RTF_CLONING - generates a new route on use
280 -xresolve RTF_XRESOLVE - emit mesg on use (for external lookup)
281 -iface ~RTF_GATEWAY - destination is directly reachable
282 -static RTF_STATIC - manually added route
283 -nostatic ~RTF_STATIC - pretend route added by kernel or daemon
284 -reject RTF_REJECT - emit an ICMP unreachable when matched
285 -blackhole RTF_BLACKHOLE - silently discard pkts (during updates)
286 -proto1 RTF_PROTO1 - set protocol specific routing flag #1
287 -proto2 RTF_PROTO2 - set protocol specific routing flag #2
288 -llinfo RTF_LLINFO - validly translates proto addr to link addr
289 .Ed
290 .Pp
291 The optional modifiers
292 .Fl rtt ,
293 .Fl rttvar ,
294 .Fl sendpipe ,
295 .Fl recvpipe ,
296 .Fl mtu ,
297 .Fl hopcount ,
298 .Fl expire ,
299 and
300 .Fl ssthresh
301 provide initial values to quantities maintained in the routing entry
302 by transport level protocols, such as TCP or TP4.
303 These may be individually locked by preceding each such modifier to
304 be locked by
305 the
306 .Fl lock
307 meta-modifier, or one can
308 specify that all ensuing metrics may be locked by the
309 .Fl lockrest
310 meta-modifier.
311 .Pp
312 In a
313 .Cm change
314 or
315 .Cm add
316 command where the destination and gateway are not sufficient to specify
317 the route (as in the
318 .Tn ISO
319 case where several interfaces may have the
320 same address), the
321 .Fl ifp
322 or
323 .Fl ifa
324 modifiers may be used to determine the interface or interface address.
325 .Pp
326 The optional
327 .Fl proxy
328 modifier specifies that the
329 .Dv RTF_LLINFO
330 routing table entry is the
331 .Dq published (proxy-only)
332 .Tn ARP
333 entry, as reported by
334 .Xr arp 8 .
335 .Pp
336 All symbolic names specified for a
337 .Ar destination
338 or
339 .Ar gateway
340 are looked up first as a host name using
341 .Xr gethostbyname 3 .
342 If this lookup fails,
343 .Xr getnetbyname 3
344 is then used to interpret the name as that of a network.
345 .Pp
346 .Nm Route
347 uses a routing socket and the new message types
348 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
349 and
350 .Dv RTM_CHANGE .
351 As such, only the super-user may modify
352 the routing tables.
353 .Sh DIAGNOSTICS
354 .Bl -diag
355 .It "add [host \&| network ] %s: gateway %s flags %x"
356 The specified route is being added to the tables. The
357 values printed are from the routing table entry supplied
358 in the
359 .Xr ioctl 2
360 call.
361 If the gateway address used was not the primary address of the gateway
362 (the first one returned by
363 .Xr gethostbyname 3 ) ,
364 the gateway address is printed numerically as well as symbolically.
365 .It "delete [ host \&| network ] %s: gateway %s flags %x"
366 As above, but when deleting an entry.
367 .It "%s %s done"
368 When the
369 .Cm flush
370 command is specified, each routing table entry deleted
371 is indicated with a message of this form.
372 .It "Network is unreachable"
373 An attempt to add a route failed because the gateway listed was not
374 on a directly-connected network.
375 The next-hop gateway must be given.
376 .It "not in table"
377 A delete operation was attempted for an entry which
378 wasn't present in the tables.
379 .It "routing table overflow"
380 An add operation was attempted, but the system was
381 low on resources and was unable to allocate memory
382 to create the new entry.
383 .It "gateway uses the same route"
384 A
385 .Cm change
386 operation resulted in a route whose gateway uses the
387 same route as the one being changed.
388 The next-hop gateway should be reachable through a different route.
389 .El
390 .Pp
391 .Ex -std
392 .Sh SEE ALSO
393 .Xr netintro 4 ,
394 .Xr route 4 ,
395 .Xr arp 8 ,
396 .Xr routed 8
397 .Sh HISTORY
398 The
399 .Nm
400 command appeared in
401 .Bx 4.2 .
402 .Sh BUGS
403 The first paragraph may have slightly exaggerated
404 .Xr routed 8 Ns 's
405 abilities.