← Back to branch summary

~ubuntu-branches/ubuntu/saucy/net-tools/saucy-proposed

« back to all changes in this revision

Viewing changes to man/en_US/route.8

  • Committer: Bazaar Package Importer
  • Author(s): Muharem Hrnjadovic
  • Date: 2009-05-04 12:29:43 UTC
  • mfrom: (3.1.3 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090504122943-6zyafjosb8a1u21q
Tags: 1.60-23ubuntu1
https://launchpad.net/bugs/240073
https://launchpad.net/bugs/66209
* Merge from debian unstable, remaining changes:
  Ubuntu_unit_conversion.patch:
    - the diff-style patch was converted into quilt format
    - Ubuntu Policy: output using standard SI unit multiples:
      KB (10^3), MB (10^6), GB (10^9), TB (10^12) and PB (10^15).
      Includes manpage update to remove comment about IEC units.
      LP: #240073.
  Dropped patches, already in debian:
    - lib/ec_hw.c: #include <stddef.h to get definition of NULL.
    - lib/fddi.c: #include <linux/types.h> to get types.  LP: #66209.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/en_US/route.8
1
 
.TH ROUTE 8 "2007-12-02" "net\-tools" "Linux Programmer's Manual"
 
1
.TH ROUTE 8 "2 January 2000" "net-tools" "Linux Programmer's Manual"
2
2
.SH NAME
3
3
route \- show / manipulate the IP routing table
4
4
.SH SYNOPSIS
51
51
.RB [ \-V ] 
52
52
.RB [ \-\-version ]
53
53
.RB [ \-h ]
54
 
.RB [ \-\-help ]
 
54
.RB [ \--help ]
55
55
.SH DESCRIPTION
56
56
.B Route
57
57
manipulates the kernel's IP routing tables.  Its primary use is to set
73
73
.SH OPTIONS
74
74
.TP
75
75
.B \-A family
76
 
use the specified address family (eg `inet'; use `route \-\-help' for a full 
 
76
use the specified address family (eg `inet'; use `route --help' for a full 
77
77
list).
78
78
 
79
79
.TP 
80
 
.B \-F
 
80
.B -F
81
81
operate on the kernel's FIB (Forwarding Information Base) routing
82
82
table. 
83
83
This is the default.
84
84
.TP 
85
 
.B \-C
 
85
.B -C
86
86
operate on the kernel's routing cache.
87
87
 
88
88
.TP
96
96
.TP
97
97
.B \-e
98
98
use
99
 
.BR netstat (8)\-format
 
99
.BR netstat (8)-format
100
100
for displaying the routing table.
101
101
.B \-ee 
102
102
will generate a very long line with all parameters from the routing table.
117
117
.B target
118
118
is a network.
119
119
.TP
120
 
.B \-host
 
120
.B -host
121
121
the
122
122
.B target 
123
123
is a host.
141
141
set the TCP Maximum Segment Size (MSS) for connections over this route
142
142
to M bytes. 
143
143
The default is the device MTU minus headers, or a lower MTU when path mtu 
144
 
discovery occurred. This setting can be used to force smaller TCP packets on the
 
144
discovery occured. This setting can be used to force smaller TCP packets on the
145
145
other end when path mtu discovery does not work (usually because of
146
146
misconfigured firewalls that block ICMP Fragmentation Needed)
147
147
.TP 
179
179
 
180
180
.SH EXAMPLES
181
181
.TP
182
 
.B route add \-net 127.0.0.0 netmask 255.0.0.0 dev lo
183
 
adds the normal loopback entry, using netmask 255.0.0.0 and associated with the 
184
 
"lo" device (assuming this device was previously set up correctly with
 
182
.B route add -net 127.0.0.0
 
183
adds the normal loopback entry, using netmask 255.0.0.0 (class A net,
 
184
determined from the destination address) and associated with the 
 
185
"lo" device (assuming this device was prviously set up correctly with
185
186
.BR ifconfig (8)). 
186
187
 
187
188
.TP 
188
 
.B route add \-net 192.56.76.0 netmask 255.255.255.0 dev eth0
189
 
adds a route to the local network 192.56.76.x via 
190
 
"eth0".  The word "dev" can be omitted here. 
191
 
 
192
 
.TP
193
 
.B route del default
194
 
deletes the current default route, which is labeled "default" or 0.0.0.0
195
 
in the destination field of the current routing table.
196
 
 
197
 
.TP
198
 
.B route add default gw mango\-gw
 
189
.B route add -net 192.56.76.0 netmask 255.255.255.0 dev eth0
 
190
adds a route to the network 192.56.76.x via 
 
191
"eth0". The Class C netmask modifier is not really necessary here because
 
192
192.* is a Class C IP address. The word "dev" can be omitted here. 
 
193
 
 
194
.TP
 
195
.B route add default gw mango-gw
199
196
adds a default route (which will be used if no other route matches).
200
 
All packets using this route will be gatewayed through "mango\-gw". The
 
197
All packets using this route will be gatewayed through "mango-gw". The
201
198
device which will actually be used for that route depends on how we
202
 
can reach "mango\-gw" - the static route to "mango\-gw" will have to be
 
199
can reach "mango-gw" - the static route to "mango-gw" will have to be
203
200
set up before. 
204
201
 
205
202
.TP
208
205
"ipx4" is the SLIP host).
209
206
 
210
207
.TP
211
 
.B route add \-net 192.57.66.0 netmask 255.255.255.0 gw ipx4
 
208
.B route add -net 192.57.66.0 netmask 255.255.255.0 gw ipx4
212
209
This command adds the net "192.57.66.x" to be gatewayed through the former
213
210
route to the SLIP interface.
214
211
 
215
212
.TP
216
 
.B route add \-net 224.0.0.0 netmask 240.0.0.0 dev eth0
 
213
.B route add -net 224.0.0.0 netmask 240.0.0.0 dev eth0
217
214
This is an obscure one documented so people know how to do it. This sets
218
215
all of the class D (multicast) IP routes to go via "eth0". This is the
219
216
correct normal configuration line with a multicasting kernel. 
220
217
 
221
218
.TP
222
 
.B route add \-net 10.0.0.0 netmask 255.0.0.0 reject
 
219
.B route add -net 10.0.0.0 netmask 255.0.0.0 reject
223
220
This installs a rejecting route for the private network "10.x.x.x."
224
221
 
225
222
.LP
285
282
Number of references to this route. (Not used in the Linux kernel.)
286
283
.TP
287
284
.B Use
288
 
Count of lookups for the route.  Depending on the use of \-F and \-C this will
289
 
be either route cache misses (\-F) or hits (\-C).
 
285
Count of lookups for the route.  Depending on the use of -F and -C this will
 
286
be either route cache misses (-F) or hits (-C).
290
287
.TP
291
288
.B Iface
292
289
Interface to which packets for this route will be sent.
293
290
.TP
294
291
.B MSS 
295
 
Default maximum segment size for TCP connections over this route.
 
292
Default maximum segement size for TCP connections over this route.
296
293
.TP
297
294
.B Window  
298
295
Default window size for TCP connections over this route.
326
323
Linus Torvalds for pl15. Alan Cox added the mss and window options for
327
324
Linux 1.1.22. irtt support and merged with netstat from Bernd Eckenfels.
328
325
.SH AUTHOR
329
 
Currently maintained by Phil Blundell <Philip.Blundell@pobox.com> and Bernd Eckenfels <net-tools@lina.inka.de>.
 
326
Currently maintained by Phil Blundell <Philip.Blundell@pobox.com>.