[a088964] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[b06ca36] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[a088964] | 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
[bdea25ce] | 7 |
|
---|
[81fd230] | 8 | <sect1 id="ch-system-iproute2" role="wrap">
|
---|
[bdea25ce] | 9 | <?dbhtml filename="iproute2.html"?>
|
---|
| 10 |
|
---|
[e747759] | 11 | <sect1info condition="script">
|
---|
| 12 | <productname>iproute2</productname>
|
---|
| 13 | <productnumber>&iproute2-version;</productnumber>
|
---|
| 14 | <address>&iproute2-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
[f0d59f2] | 17 | <title>IPRoute2-&iproute2-version;</title>
|
---|
[bdea25ce] | 18 |
|
---|
[a088964] | 19 | <indexterm zone="ch-system-iproute2">
|
---|
[89ed081] | 20 | <primary sortas="a-IPRoute2">IPRoute2</primary>
|
---|
[a088964] | 21 | </indexterm>
|
---|
[bdea25ce] | 22 |
|
---|
[a088964] | 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
[bdea25ce] | 25 |
|
---|
| 26 | <para>The IPRoute2 package contains programs for basic and advanced IPV4-based
|
---|
| 27 | networking.</para>
|
---|
| 28 |
|
---|
[a088964] | 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
[bdea25ce] | 32 |
|
---|
[a088964] | 33 | <seglistitem>
|
---|
[e4a5635] | 34 | <seg>&iproute2-ch6-sbu;</seg>
|
---|
| 35 | <seg>&iproute2-ch6-du;</seg>
|
---|
[a088964] | 36 | </seglistitem>
|
---|
| 37 | </segmentedlist>
|
---|
[bdea25ce] | 38 |
|
---|
[a088964] | 39 | </sect2>
|
---|
[bdea25ce] | 40 |
|
---|
[a088964] | 41 | <sect2 role="installation">
|
---|
[f0d59f2] | 42 | <title>Installation of IPRoute2</title>
|
---|
[a088964] | 43 |
|
---|
[9cccea2] | 44 | <para>The <command>arpd</command> binary included in this package is
|
---|
| 45 | dependent on Berkeley DB. Because <command>arpd</command> is not a very
|
---|
[bf10add] | 46 | common requirement on a base Linux system, remove the dependency on Berkeley
|
---|
| 47 | DB by applying the commands below. If the <command>arpd</command> binary is
|
---|
| 48 | needed, instructions for compiling Berkeley DB can be found in the BLFS Book
|
---|
| 49 | at <ulink url="&blfs-root;view/svn/server/databases.html#db"/>.
|
---|
[9cccea2] | 50 | </para>
|
---|
| 51 |
|
---|
[bf10add] | 52 | <screen><userinput remap="pre">sed -i '/^TARGETS/s@arpd@@g' misc/Makefile
|
---|
| 53 | sed -i /ARPD/d Makefile
|
---|
[04b82390] | 54 | sed -i 's/arpd.8//' man/man8/Makefile</userinput></screen>
|
---|
[9cccea2] | 55 |
|
---|
[a088964] | 56 | <para>Compile the package:</para>
|
---|
| 57 |
|
---|
[aa909a0] | 58 | <screen><userinput remap="make">make DESTDIR=</userinput></screen>
|
---|
[81fd230] | 59 |
|
---|
| 60 | <variablelist>
|
---|
[aa909a0] | 61 | <title>The meaning of the make option:</title>
|
---|
[7af598d1] | 62 |
|
---|
| 63 | <varlistentry>
|
---|
| 64 | <term><parameter>DESTDIR=</parameter></term>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>This ensures that the IPRoute2 binaries will install into
|
---|
| 67 | the correct directory. By default, <parameter>DESTDIR</parameter> is
|
---|
| 68 | set to <filename class="directory">/usr</filename>.</para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </varlistentry>
|
---|
[bdea25ce] | 71 |
|
---|
[81fd230] | 72 | </variablelist>
|
---|
| 73 |
|
---|
[0ebe029b] | 74 | <para>This package comes with a test suite, but due to assumptions it makes,
|
---|
[971be6b] | 75 | it is not possible to reliably run these tests from within the chroot
|
---|
| 76 | environment. If you wish to run these tests after booting into your new LFS
|
---|
| 77 | system, ensure you select <filename>/proc/config.gz</filename>
|
---|
| 78 | CONFIG_IKCONFIG_PROC ("General setup" -> "Enable access to
|
---|
| 79 | .config through /proc/config.gz") support into your kernel then run
|
---|
| 80 | 'make alltests' from the <filename class="directory">testsuite/</filename>
|
---|
| 81 | subdirectory.</para>
|
---|
[0be3d41] | 82 |
|
---|
[81fd230] | 83 | <para>Install the package:</para>
|
---|
| 84 |
|
---|
[7b08ae24] | 85 | <screen><userinput remap="install">make DESTDIR= \
|
---|
[9f5aaf7] | 86 | MANDIR=/usr/share/man \
|
---|
[bdb3cca] | 87 | DOCDIR=/usr/share/doc/iproute2-&iproute2-version; install</userinput></screen>
|
---|
[bdea25ce] | 88 |
|
---|
[a088964] | 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 id="contents-iproute2" role="content">
|
---|
[f0d59f2] | 92 | <title>Contents of IPRoute2</title>
|
---|
[bdea25ce] | 93 |
|
---|
[81fd230] | 94 | <segmentedlist>
|
---|
| 95 | <segtitle>Installed programs</segtitle>
|
---|
[fe05b08] | 96 | <segtitle>Installed directories</segtitle>
|
---|
[bdea25ce] | 97 |
|
---|
[81fd230] | 98 | <seglistitem>
|
---|
[ca101ad] | 99 | <seg>bridge, ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
|
---|
[2791a8e] | 100 | nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
|
---|
[79f9e00] | 101 | and tc</seg>
|
---|
[fe05b08] | 102 | <seg>/etc/iproute2, /lib/tc, /usr/share/doc/iproute2-&iproute2-version;,
|
---|
| 103 | /usr/lib/tc</seg>
|
---|
[81fd230] | 104 | </seglistitem>
|
---|
| 105 | </segmentedlist>
|
---|
| 106 |
|
---|
[bdea25ce] | 107 | <variablelist>
|
---|
| 108 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 109 | <?dbfo list-presentation="list"?>
|
---|
| 110 | <?dbhtml list-presentation="table"?>
|
---|
| 111 |
|
---|
[ca101ad] | 112 | <varlistentry id="bridge">
|
---|
| 113 | <term><command>bridge</command></term>
|
---|
| 114 | <listitem>
|
---|
| 115 | <para>Configures network bridges</para>
|
---|
| 116 | <indexterm zone="ch-system-iproute2 bridge">
|
---|
| 117 | <primary sortas="b-bridge">bridge</primary>
|
---|
| 118 | </indexterm>
|
---|
| 119 | </listitem>
|
---|
| 120 | </varlistentry>
|
---|
| 121 |
|
---|
[46a500e] | 122 | <varlistentry id="ctstat">
|
---|
[bdea25ce] | 123 | <term><command>ctstat</command></term>
|
---|
[46a500e] | 124 | <listitem>
|
---|
[89ed081] | 125 | <para>Connection status utility</para>
|
---|
[46a500e] | 126 | <indexterm zone="ch-system-iproute2 ctstat">
|
---|
[005dc3f] | 127 | <primary sortas="b-ctstat">ctstat</primary>
|
---|
[46a500e] | 128 | </indexterm>
|
---|
| 129 | </listitem>
|
---|
| 130 | </varlistentry>
|
---|
| 131 |
|
---|
[2791a8e] | 132 | <varlistentry id="genl">
|
---|
| 133 | <term><command>genl</command></term>
|
---|
| 134 | <listitem>
|
---|
| 135 | <para></para>
|
---|
| 136 | <indexterm zone="ch-system-iproute2 genl">
|
---|
| 137 | <primary sortas="b-genl">genl</primary>
|
---|
| 138 | </indexterm>
|
---|
| 139 | </listitem>
|
---|
| 140 | </varlistentry>
|
---|
| 141 |
|
---|
[46a500e] | 142 | <varlistentry id="ifcfg">
|
---|
[bdea25ce] | 143 | <term><command>ifcfg</command></term>
|
---|
[46a500e] | 144 | <listitem>
|
---|
[46fbbc2] | 145 | <para>A shell script wrapper for the <command>ip</command> command.
|
---|
| 146 | Note that it requires the <command>arping</command> and
|
---|
| 147 | <command>rdisk</command> programs from the
|
---|
| 148 | iputils package found at <ulink url="http://www.skbuff.net/iputils/"/>.</para>
|
---|
[46a500e] | 149 | <indexterm zone="ch-system-iproute2 ifcfg">
|
---|
| 150 | <primary sortas="b-ifcfg">ifcfg</primary>
|
---|
| 151 | </indexterm>
|
---|
| 152 | </listitem>
|
---|
| 153 | </varlistentry>
|
---|
[81fd230] | 154 |
|
---|
| 155 | <varlistentry id="ifstat">
|
---|
[bdea25ce] | 156 | <term><command>ifstat</command></term>
|
---|
[81fd230] | 157 | <listitem>
|
---|
[bdea25ce] | 158 | <para>Shows the interface statistics, including the amount of
|
---|
| 159 | transmitted and received packets by interface</para>
|
---|
[81fd230] | 160 | <indexterm zone="ch-system-iproute2 ifstat">
|
---|
| 161 | <primary sortas="b-ifstat">ifstat</primary>
|
---|
| 162 | </indexterm>
|
---|
| 163 | </listitem>
|
---|
| 164 | </varlistentry>
|
---|
| 165 |
|
---|
| 166 | <varlistentry id="ip">
|
---|
[bdea25ce] | 167 | <term><command>ip</command></term>
|
---|
[81fd230] | 168 | <listitem>
|
---|
| 169 | <para>The main executable. It has several different functions:</para>
|
---|
| 170 |
|
---|
[0090db5] | 171 | <para><command>ip link <replaceable><device></replaceable></command>
|
---|
[bdea25ce] | 172 | allows users to look at the state of devices and to make changes</para>
|
---|
[81fd230] | 173 |
|
---|
| 174 | <para><command>ip addr</command> allows users to look at addresses and
|
---|
[bdea25ce] | 175 | their properties, add new addresses, and delete old ones</para>
|
---|
[81fd230] | 176 |
|
---|
[bdea25ce] | 177 | <para><command>ip neighbor</command> allows users to look at neighbor
|
---|
| 178 | bindings and their properties, add new neighbor entries, and delete
|
---|
| 179 | old ones</para>
|
---|
[81fd230] | 180 |
|
---|
| 181 | <para><command>ip rule</command> allows users to look at the routing
|
---|
[bdea25ce] | 182 | policies and change them</para>
|
---|
[81fd230] | 183 |
|
---|
| 184 | <para><command>ip route</command> allows users to look at the routing
|
---|
[bdea25ce] | 185 | table and change routing table rules</para>
|
---|
[81fd230] | 186 |
|
---|
| 187 | <para><command>ip tunnel</command> allows users to look at the IP
|
---|
[bdea25ce] | 188 | tunnels and their properties, and change them</para>
|
---|
[81fd230] | 189 |
|
---|
| 190 | <para><command>ip maddr</command> allows users to look at the multicast
|
---|
[bdea25ce] | 191 | addresses and their properties, and change them</para>
|
---|
[81fd230] | 192 |
|
---|
| 193 | <para><command>ip mroute</command> allows users to set, change, or
|
---|
[bdea25ce] | 194 | delete the multicast routing</para>
|
---|
[81fd230] | 195 |
|
---|
[cb02946] | 196 | <para><command>ip monitor</command> allows users to continuously monitor
|
---|
[bdea25ce] | 197 | the state of devices, addresses and routes</para>
|
---|
[81fd230] | 198 | <indexterm zone="ch-system-iproute2 ip">
|
---|
| 199 | <primary sortas="b-ip">ip</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
[46a500e] | 204 | <varlistentry id="lnstat">
|
---|
[bdea25ce] | 205 | <term><command>lnstat</command></term>
|
---|
[46a500e] | 206 | <listitem>
|
---|
| 207 | <para>Provides Linux network statistics. It is a generalized and more
|
---|
[bdea25ce] | 208 | feature-complete replacement for the old <command>rtstat</command>
|
---|
| 209 | program</para>
|
---|
[46a500e] | 210 | <indexterm zone="ch-system-iproute2 lnstat">
|
---|
[005dc3f] | 211 | <primary sortas="b-lnstat">lnstat</primary>
|
---|
[46a500e] | 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 |
|
---|
[81fd230] | 216 | <varlistentry id="nstat">
|
---|
[bdea25ce] | 217 | <term><command>nstat</command></term>
|
---|
[81fd230] | 218 | <listitem>
|
---|
[89ed081] | 219 | <para>Shows network statistics</para>
|
---|
[81fd230] | 220 | <indexterm zone="ch-system-iproute2 nstat">
|
---|
| 221 | <primary sortas="b-nstat">nstat</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="routef">
|
---|
[bdea25ce] | 227 | <term><command>routef</command></term>
|
---|
[81fd230] | 228 | <listitem>
|
---|
[bdea25ce] | 229 | <para>A component of <command>ip route</command>. This is for flushing
|
---|
| 230 | the routing tables</para>
|
---|
[81fd230] | 231 | <indexterm zone="ch-system-iproute2 routef">
|
---|
| 232 | <primary sortas="b-routef">routef</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 |
|
---|
| 237 | <varlistentry id="routel">
|
---|
[bdea25ce] | 238 | <term><command>routel</command></term>
|
---|
[81fd230] | 239 | <listitem>
|
---|
[bdea25ce] | 240 | <para>A component of <command>ip route</command>. This is for listing
|
---|
| 241 | the routing tables</para>
|
---|
[81fd230] | 242 | <indexterm zone="ch-system-iproute2 routel">
|
---|
| 243 | <primary sortas="b-routel">routel</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
[46a500e] | 248 | <varlistentry id="rtacct">
|
---|
[bdea25ce] | 249 | <term><command>rtacct</command></term>
|
---|
[46a500e] | 250 | <listitem>
|
---|
[bdea25ce] | 251 | <para>Displays the contents of
|
---|
| 252 | <filename>/proc/net/rt_acct</filename></para>
|
---|
[46a500e] | 253 | <indexterm zone="ch-system-iproute2 rtacct">
|
---|
| 254 | <primary sortas="b-rtacct">rtacct</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
[81fd230] | 259 | <varlistentry id="rtmon">
|
---|
[bdea25ce] | 260 | <term><command>rtmon</command></term>
|
---|
[81fd230] | 261 | <listitem>
|
---|
[89ed081] | 262 | <para>Route monitoring utility</para>
|
---|
[81fd230] | 263 | <indexterm zone="ch-system-iproute2 rtmon">
|
---|
| 264 | <primary sortas="b-rtmon">rtmon</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
[46a500e] | 269 | <varlistentry id="rtpr">
|
---|
[bdea25ce] | 270 | <term><command>rtpr</command></term>
|
---|
[46a500e] | 271 | <listitem>
|
---|
| 272 | <para>Converts the output of <command>ip -o</command> back into a
|
---|
[bdea25ce] | 273 | readable form</para>
|
---|
[46a500e] | 274 | <indexterm zone="ch-system-iproute2 rtpr">
|
---|
| 275 | <primary sortas="b-rtpr">rtpr</primary>
|
---|
| 276 | </indexterm>
|
---|
| 277 | </listitem>
|
---|
| 278 | </varlistentry>
|
---|
| 279 |
|
---|
[81fd230] | 280 | <varlistentry id="rtstat">
|
---|
[bdea25ce] | 281 | <term><command>rtstat</command></term>
|
---|
[81fd230] | 282 | <listitem>
|
---|
[89ed081] | 283 | <para>Route status utility</para>
|
---|
[81fd230] | 284 | <indexterm zone="ch-system-iproute2 rtstat">
|
---|
| 285 | <primary sortas="b-rtstat">rtstat</primary>
|
---|
| 286 | </indexterm>
|
---|
| 287 | </listitem>
|
---|
| 288 | </varlistentry>
|
---|
| 289 |
|
---|
| 290 | <varlistentry id="ss">
|
---|
[bdea25ce] | 291 | <term><command>ss</command></term>
|
---|
[81fd230] | 292 | <listitem>
|
---|
[bdea25ce] | 293 | <para>Similar to the <command>netstat</command> command; shows active
|
---|
| 294 | connections</para>
|
---|
[81fd230] | 295 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 296 | <primary sortas="b-ss">ss</primary>
|
---|
| 297 | </indexterm>
|
---|
| 298 | </listitem>
|
---|
| 299 | </varlistentry>
|
---|
| 300 |
|
---|
| 301 | <varlistentry id="tc">
|
---|
[bdea25ce] | 302 | <term><command>tc</command></term>
|
---|
[81fd230] | 303 | <listitem>
|
---|
[bdea25ce] | 304 | <para>Traffic Controlling Executable; this is for Quality Of Service
|
---|
| 305 | (QOS) and Class Of Service (COS) implementations</para>
|
---|
[81fd230] | 306 |
|
---|
| 307 | <para><command>tc qdisc</command> allows users to setup the queueing
|
---|
[bdea25ce] | 308 | discipline</para>
|
---|
[81fd230] | 309 |
|
---|
[bdea25ce] | 310 | <para><command>tc class</command> allows users to setup classes based
|
---|
| 311 | on the queuing discipline scheduling</para>
|
---|
[81fd230] | 312 |
|
---|
| 313 | <para><command>tc estimator</command> allows users to estimate the
|
---|
[bdea25ce] | 314 | network flow into a network</para>
|
---|
[81fd230] | 315 |
|
---|
| 316 | <para><command>tc filter</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 317 | packet filtering</para>
|
---|
[81fd230] | 318 |
|
---|
| 319 | <para><command>tc policy</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 320 | policies</para>
|
---|
[81fd230] | 321 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 322 | <primary sortas="b-tc">tc</primary>
|
---|
| 323 | </indexterm>
|
---|
| 324 | </listitem>
|
---|
| 325 | </varlistentry>
|
---|
[bdea25ce] | 326 |
|
---|
[81fd230] | 327 | </variablelist>
|
---|
[bdea25ce] | 328 |
|
---|
[a088964] | 329 | </sect2>
|
---|
[81fd230] | 330 |
|
---|
[bdea25ce] | 331 | </sect1>
|
---|