[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
|
---|
| 54 | rm man/man8/arpd.8</userinput></screen>
|
---|
[9cccea2] | 55 |
|
---|
[09d0e59] | 56 | <para>Remove references to some Libnl headers that are not required by
|
---|
| 57 | IPRoute2:</para>
|
---|
| 58 |
|
---|
| 59 | <screen><userinput remap="pre">sed -i -e '/netlink\//d' ip/ipl2tp.c</userinput></screen>
|
---|
| 60 |
|
---|
[a088964] | 61 | <para>Compile the package:</para>
|
---|
| 62 |
|
---|
[aa909a0] | 63 | <screen><userinput remap="make">make DESTDIR=</userinput></screen>
|
---|
[81fd230] | 64 |
|
---|
| 65 | <variablelist>
|
---|
[aa909a0] | 66 | <title>The meaning of the make option:</title>
|
---|
[7af598d1] | 67 |
|
---|
| 68 | <varlistentry>
|
---|
| 69 | <term><parameter>DESTDIR=</parameter></term>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>This ensures that the IPRoute2 binaries will install into
|
---|
| 72 | the correct directory. By default, <parameter>DESTDIR</parameter> is
|
---|
| 73 | set to <filename class="directory">/usr</filename>.</para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </varlistentry>
|
---|
[bdea25ce] | 76 |
|
---|
[81fd230] | 77 | </variablelist>
|
---|
| 78 |
|
---|
[0ebe029b] | 79 | <para>This package comes with a test suite, but due to assumptions it makes,
|
---|
[971be6b] | 80 | it is not possible to reliably run these tests from within the chroot
|
---|
| 81 | environment. If you wish to run these tests after booting into your new LFS
|
---|
| 82 | system, ensure you select <filename>/proc/config.gz</filename>
|
---|
| 83 | CONFIG_IKCONFIG_PROC ("General setup" -> "Enable access to
|
---|
| 84 | .config through /proc/config.gz") support into your kernel then run
|
---|
| 85 | 'make alltests' from the <filename class="directory">testsuite/</filename>
|
---|
| 86 | subdirectory.</para>
|
---|
[0be3d41] | 87 |
|
---|
[81fd230] | 88 | <para>Install the package:</para>
|
---|
| 89 |
|
---|
[9f5aaf7] | 90 | <screen><userinput remap="install">
|
---|
| 91 | make DESTDIR= \
|
---|
| 92 | MANDIR=/usr/share/man \
|
---|
[bdb3cca] | 93 | DOCDIR=/usr/share/doc/iproute2-&iproute2-version; install</userinput></screen>
|
---|
[bdea25ce] | 94 |
|
---|
[a088964] | 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 id="contents-iproute2" role="content">
|
---|
[f0d59f2] | 98 | <title>Contents of IPRoute2</title>
|
---|
[bdea25ce] | 99 |
|
---|
[81fd230] | 100 | <segmentedlist>
|
---|
| 101 | <segtitle>Installed programs</segtitle>
|
---|
[fe05b08] | 102 | <segtitle>Installed directories</segtitle>
|
---|
[bdea25ce] | 103 |
|
---|
[81fd230] | 104 | <seglistitem>
|
---|
[9cccea2] | 105 | <seg>ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
|
---|
[2791a8e] | 106 | nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
|
---|
[79f9e00] | 107 | and tc</seg>
|
---|
[fe05b08] | 108 | <seg>/etc/iproute2, /lib/tc, /usr/share/doc/iproute2-&iproute2-version;,
|
---|
| 109 | /usr/lib/tc</seg>
|
---|
[81fd230] | 110 | </seglistitem>
|
---|
| 111 | </segmentedlist>
|
---|
| 112 |
|
---|
[bdea25ce] | 113 | <variablelist>
|
---|
| 114 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 115 | <?dbfo list-presentation="list"?>
|
---|
| 116 | <?dbhtml list-presentation="table"?>
|
---|
| 117 |
|
---|
[46a500e] | 118 | <varlistentry id="ctstat">
|
---|
[bdea25ce] | 119 | <term><command>ctstat</command></term>
|
---|
[46a500e] | 120 | <listitem>
|
---|
[89ed081] | 121 | <para>Connection status utility</para>
|
---|
[46a500e] | 122 | <indexterm zone="ch-system-iproute2 ctstat">
|
---|
[005dc3f] | 123 | <primary sortas="b-ctstat">ctstat</primary>
|
---|
[46a500e] | 124 | </indexterm>
|
---|
| 125 | </listitem>
|
---|
| 126 | </varlistentry>
|
---|
| 127 |
|
---|
[2791a8e] | 128 | <varlistentry id="genl">
|
---|
| 129 | <term><command>genl</command></term>
|
---|
| 130 | <listitem>
|
---|
| 131 | <para></para>
|
---|
| 132 | <indexterm zone="ch-system-iproute2 genl">
|
---|
| 133 | <primary sortas="b-genl">genl</primary>
|
---|
| 134 | </indexterm>
|
---|
| 135 | </listitem>
|
---|
| 136 | </varlistentry>
|
---|
| 137 |
|
---|
[46a500e] | 138 | <varlistentry id="ifcfg">
|
---|
[bdea25ce] | 139 | <term><command>ifcfg</command></term>
|
---|
[46a500e] | 140 | <listitem>
|
---|
[46fbbc2] | 141 | <para>A shell script wrapper for the <command>ip</command> command.
|
---|
| 142 | Note that it requires the <command>arping</command> and
|
---|
| 143 | <command>rdisk</command> programs from the
|
---|
| 144 | iputils package found at <ulink url="http://www.skbuff.net/iputils/"/>.</para>
|
---|
[46a500e] | 145 | <indexterm zone="ch-system-iproute2 ifcfg">
|
---|
| 146 | <primary sortas="b-ifcfg">ifcfg</primary>
|
---|
| 147 | </indexterm>
|
---|
| 148 | </listitem>
|
---|
| 149 | </varlistentry>
|
---|
[81fd230] | 150 |
|
---|
| 151 | <varlistentry id="ifstat">
|
---|
[bdea25ce] | 152 | <term><command>ifstat</command></term>
|
---|
[81fd230] | 153 | <listitem>
|
---|
[bdea25ce] | 154 | <para>Shows the interface statistics, including the amount of
|
---|
| 155 | transmitted and received packets by interface</para>
|
---|
[81fd230] | 156 | <indexterm zone="ch-system-iproute2 ifstat">
|
---|
| 157 | <primary sortas="b-ifstat">ifstat</primary>
|
---|
| 158 | </indexterm>
|
---|
| 159 | </listitem>
|
---|
| 160 | </varlistentry>
|
---|
| 161 |
|
---|
| 162 | <varlistentry id="ip">
|
---|
[bdea25ce] | 163 | <term><command>ip</command></term>
|
---|
[81fd230] | 164 | <listitem>
|
---|
| 165 | <para>The main executable. It has several different functions:</para>
|
---|
| 166 |
|
---|
[0090db5] | 167 | <para><command>ip link <replaceable><device></replaceable></command>
|
---|
[bdea25ce] | 168 | allows users to look at the state of devices and to make changes</para>
|
---|
[81fd230] | 169 |
|
---|
| 170 | <para><command>ip addr</command> allows users to look at addresses and
|
---|
[bdea25ce] | 171 | their properties, add new addresses, and delete old ones</para>
|
---|
[81fd230] | 172 |
|
---|
[bdea25ce] | 173 | <para><command>ip neighbor</command> allows users to look at neighbor
|
---|
| 174 | bindings and their properties, add new neighbor entries, and delete
|
---|
| 175 | old ones</para>
|
---|
[81fd230] | 176 |
|
---|
| 177 | <para><command>ip rule</command> allows users to look at the routing
|
---|
[bdea25ce] | 178 | policies and change them</para>
|
---|
[81fd230] | 179 |
|
---|
| 180 | <para><command>ip route</command> allows users to look at the routing
|
---|
[bdea25ce] | 181 | table and change routing table rules</para>
|
---|
[81fd230] | 182 |
|
---|
| 183 | <para><command>ip tunnel</command> allows users to look at the IP
|
---|
[bdea25ce] | 184 | tunnels and their properties, and change them</para>
|
---|
[81fd230] | 185 |
|
---|
| 186 | <para><command>ip maddr</command> allows users to look at the multicast
|
---|
[bdea25ce] | 187 | addresses and their properties, and change them</para>
|
---|
[81fd230] | 188 |
|
---|
| 189 | <para><command>ip mroute</command> allows users to set, change, or
|
---|
[bdea25ce] | 190 | delete the multicast routing</para>
|
---|
[81fd230] | 191 |
|
---|
[bdea25ce] | 192 | <para><command>ip monitor</command> allows users to continously monitor
|
---|
| 193 | the state of devices, addresses and routes</para>
|
---|
[81fd230] | 194 | <indexterm zone="ch-system-iproute2 ip">
|
---|
| 195 | <primary sortas="b-ip">ip</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
[46a500e] | 200 | <varlistentry id="lnstat">
|
---|
[bdea25ce] | 201 | <term><command>lnstat</command></term>
|
---|
[46a500e] | 202 | <listitem>
|
---|
| 203 | <para>Provides Linux network statistics. It is a generalized and more
|
---|
[bdea25ce] | 204 | feature-complete replacement for the old <command>rtstat</command>
|
---|
| 205 | program</para>
|
---|
[46a500e] | 206 | <indexterm zone="ch-system-iproute2 lnstat">
|
---|
[005dc3f] | 207 | <primary sortas="b-lnstat">lnstat</primary>
|
---|
[46a500e] | 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
[81fd230] | 212 | <varlistentry id="nstat">
|
---|
[bdea25ce] | 213 | <term><command>nstat</command></term>
|
---|
[81fd230] | 214 | <listitem>
|
---|
[89ed081] | 215 | <para>Shows network statistics</para>
|
---|
[81fd230] | 216 | <indexterm zone="ch-system-iproute2 nstat">
|
---|
| 217 | <primary sortas="b-nstat">nstat</primary>
|
---|
| 218 | </indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="routef">
|
---|
[bdea25ce] | 223 | <term><command>routef</command></term>
|
---|
[81fd230] | 224 | <listitem>
|
---|
[bdea25ce] | 225 | <para>A component of <command>ip route</command>. This is for flushing
|
---|
| 226 | the routing tables</para>
|
---|
[81fd230] | 227 | <indexterm zone="ch-system-iproute2 routef">
|
---|
| 228 | <primary sortas="b-routef">routef</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
| 233 | <varlistentry id="routel">
|
---|
[bdea25ce] | 234 | <term><command>routel</command></term>
|
---|
[81fd230] | 235 | <listitem>
|
---|
[bdea25ce] | 236 | <para>A component of <command>ip route</command>. This is for listing
|
---|
| 237 | the routing tables</para>
|
---|
[81fd230] | 238 | <indexterm zone="ch-system-iproute2 routel">
|
---|
| 239 | <primary sortas="b-routel">routel</primary>
|
---|
| 240 | </indexterm>
|
---|
| 241 | </listitem>
|
---|
| 242 | </varlistentry>
|
---|
| 243 |
|
---|
[46a500e] | 244 | <varlistentry id="rtacct">
|
---|
[bdea25ce] | 245 | <term><command>rtacct</command></term>
|
---|
[46a500e] | 246 | <listitem>
|
---|
[bdea25ce] | 247 | <para>Displays the contents of
|
---|
| 248 | <filename>/proc/net/rt_acct</filename></para>
|
---|
[46a500e] | 249 | <indexterm zone="ch-system-iproute2 rtacct">
|
---|
| 250 | <primary sortas="b-rtacct">rtacct</primary>
|
---|
| 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
[81fd230] | 255 | <varlistentry id="rtmon">
|
---|
[bdea25ce] | 256 | <term><command>rtmon</command></term>
|
---|
[81fd230] | 257 | <listitem>
|
---|
[89ed081] | 258 | <para>Route monitoring utility</para>
|
---|
[81fd230] | 259 | <indexterm zone="ch-system-iproute2 rtmon">
|
---|
| 260 | <primary sortas="b-rtmon">rtmon</primary>
|
---|
| 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
[46a500e] | 265 | <varlistentry id="rtpr">
|
---|
[bdea25ce] | 266 | <term><command>rtpr</command></term>
|
---|
[46a500e] | 267 | <listitem>
|
---|
| 268 | <para>Converts the output of <command>ip -o</command> back into a
|
---|
[bdea25ce] | 269 | readable form</para>
|
---|
[46a500e] | 270 | <indexterm zone="ch-system-iproute2 rtpr">
|
---|
| 271 | <primary sortas="b-rtpr">rtpr</primary>
|
---|
| 272 | </indexterm>
|
---|
| 273 | </listitem>
|
---|
| 274 | </varlistentry>
|
---|
| 275 |
|
---|
[81fd230] | 276 | <varlistentry id="rtstat">
|
---|
[bdea25ce] | 277 | <term><command>rtstat</command></term>
|
---|
[81fd230] | 278 | <listitem>
|
---|
[89ed081] | 279 | <para>Route status utility</para>
|
---|
[81fd230] | 280 | <indexterm zone="ch-system-iproute2 rtstat">
|
---|
| 281 | <primary sortas="b-rtstat">rtstat</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | <varlistentry id="ss">
|
---|
[bdea25ce] | 287 | <term><command>ss</command></term>
|
---|
[81fd230] | 288 | <listitem>
|
---|
[bdea25ce] | 289 | <para>Similar to the <command>netstat</command> command; shows active
|
---|
| 290 | connections</para>
|
---|
[81fd230] | 291 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 292 | <primary sortas="b-ss">ss</primary>
|
---|
| 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
| 296 |
|
---|
| 297 | <varlistentry id="tc">
|
---|
[bdea25ce] | 298 | <term><command>tc</command></term>
|
---|
[81fd230] | 299 | <listitem>
|
---|
[bdea25ce] | 300 | <para>Traffic Controlling Executable; this is for Quality Of Service
|
---|
| 301 | (QOS) and Class Of Service (COS) implementations</para>
|
---|
[81fd230] | 302 |
|
---|
| 303 | <para><command>tc qdisc</command> allows users to setup the queueing
|
---|
[bdea25ce] | 304 | discipline</para>
|
---|
[81fd230] | 305 |
|
---|
[bdea25ce] | 306 | <para><command>tc class</command> allows users to setup classes based
|
---|
| 307 | on the queuing discipline scheduling</para>
|
---|
[81fd230] | 308 |
|
---|
| 309 | <para><command>tc estimator</command> allows users to estimate the
|
---|
[bdea25ce] | 310 | network flow into a network</para>
|
---|
[81fd230] | 311 |
|
---|
| 312 | <para><command>tc filter</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 313 | packet filtering</para>
|
---|
[81fd230] | 314 |
|
---|
| 315 | <para><command>tc policy</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 316 | policies</para>
|
---|
[81fd230] | 317 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 318 | <primary sortas="b-tc">tc</primary>
|
---|
| 319 | </indexterm>
|
---|
| 320 | </listitem>
|
---|
| 321 | </varlistentry>
|
---|
[bdea25ce] | 322 |
|
---|
[81fd230] | 323 | </variablelist>
|
---|
[bdea25ce] | 324 |
|
---|
[a088964] | 325 | </sect2>
|
---|
[81fd230] | 326 |
|
---|
[bdea25ce] | 327 | </sect1>
|
---|