[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>
|
---|
[fb386e0] | 34 | <seg>&iproute2-fin-sbu;</seg>
|
---|
| 35 | <seg>&iproute2-fin-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 |
|
---|
[e691c77] | 44 | <para>The <command>arpd</command> program included in this package will not
|
---|
| 45 | be built since it is dependent on Berkeley DB, which is not installed in
|
---|
[d672ab7] | 46 | LFS. However, a directory for <command>arpd</command> and a man page will still
|
---|
| 47 | be installed. Prevent this by running the commands below.
|
---|
[31c3309] | 48 | If the <command>arpd</command> binary is needed,
|
---|
[e691c77] | 49 | instructions for compiling Berkeley DB can be found in the BLFS Book at
|
---|
[6a156bab] | 50 | <ulink url="&blfs-book;server/db.html"/>.
|
---|
[9cccea2] | 51 | </para>
|
---|
| 52 |
|
---|
[e691c77] | 53 | <screen><userinput remap="pre">sed -i /ARPD/d Makefile
|
---|
[31c3309] | 54 | rm -fv man/man8/arpd.8</userinput></screen>
|
---|
[9cccea2] | 55 |
|
---|
[60933b9] | 56 | <!-- fixed upstream for 5.16.0
|
---|
[d672ab7] | 57 | <para>It is also necessary to disable building two modules that
|
---|
[6a156bab] | 58 | require <ulink url="&blfs-book;postlfs/iptables.html"/>.</para>
|
---|
[6934b62] | 59 |
|
---|
[b30de8f] | 60 | <screen><userinput remap="pre">sed -i 's/.m_ipt.o//' tc/Makefile</userinput></screen>
|
---|
[60933b9] | 61 | -->
|
---|
[a088964] | 62 | <para>Compile the package:</para>
|
---|
| 63 |
|
---|
[859502b] | 64 | <screen><userinput remap="make">make NETNS_RUN_DIR=/run/netns</userinput></screen>
|
---|
[81fd230] | 65 |
|
---|
[239518f] | 66 | <para>This package does not have a working test suite.</para>
|
---|
| 67 | <!-- currently not useful, no tests actually run
|
---|
[0ebe029b] | 68 | <para>This package comes with a test suite, but due to assumptions it makes,
|
---|
[971be6b] | 69 | it is not possible to reliably run these tests from within the chroot
|
---|
| 70 | environment. If you wish to run these tests after booting into your new LFS
|
---|
[d450151] | 71 | system, ensure you enable <filename>/proc/config.gz</filename> support
|
---|
| 72 | in your kernel ("General setup" -> "Enable access to
|
---|
| 73 | .config through /proc/config.gz" [CONFIG_IKCONFIG_PROC]), then run
|
---|
[971be6b] | 74 | 'make alltests' from the <filename class="directory">testsuite/</filename>
|
---|
[239518f] | 75 | subdirectory.</para>-->
|
---|
[0be3d41] | 76 |
|
---|
[81fd230] | 77 | <para>Install the package:</para>
|
---|
| 78 |
|
---|
[c36301e7] | 79 | <screen><userinput remap="install">make SBINDIR=/usr/sbin install</userinput></screen>
|
---|
[8d5f7c75] | 80 |
|
---|
| 81 | <para>If desired, install the documentation:</para>
|
---|
| 82 |
|
---|
[8fd9f81] | 83 | <screen><userinput remap="install">mkdir -pv /usr/share/doc/iproute2-&iproute2-version;
|
---|
[8d5f7c75] | 84 | cp -v COPYING README* /usr/share/doc/iproute2-&iproute2-version;</userinput></screen>
|
---|
[bdea25ce] | 85 |
|
---|
[a088964] | 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2 id="contents-iproute2" role="content">
|
---|
[f0d59f2] | 89 | <title>Contents of IPRoute2</title>
|
---|
[bdea25ce] | 90 |
|
---|
[81fd230] | 91 | <segmentedlist>
|
---|
| 92 | <segtitle>Installed programs</segtitle>
|
---|
[fe05b08] | 93 | <segtitle>Installed directories</segtitle>
|
---|
[bdea25ce] | 94 |
|
---|
[81fd230] | 95 | <seglistitem>
|
---|
[ca101ad] | 96 | <seg>bridge, ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
|
---|
[2791a8e] | 97 | nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
|
---|
[79f9e00] | 98 | and tc</seg>
|
---|
[8d35535] | 99 | <seg>/etc/iproute2, /usr/lib/tc, and /usr/share/doc/iproute2-&iproute2-version;
|
---|
[0aa4782] | 100 | </seg>
|
---|
[81fd230] | 101 | </seglistitem>
|
---|
| 102 | </segmentedlist>
|
---|
| 103 |
|
---|
[bdea25ce] | 104 | <variablelist>
|
---|
| 105 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 106 | <?dbfo list-presentation="list"?>
|
---|
| 107 | <?dbhtml list-presentation="table"?>
|
---|
| 108 |
|
---|
[ca101ad] | 109 | <varlistentry id="bridge">
|
---|
| 110 | <term><command>bridge</command></term>
|
---|
| 111 | <listitem>
|
---|
| 112 | <para>Configures network bridges</para>
|
---|
| 113 | <indexterm zone="ch-system-iproute2 bridge">
|
---|
| 114 | <primary sortas="b-bridge">bridge</primary>
|
---|
| 115 | </indexterm>
|
---|
| 116 | </listitem>
|
---|
| 117 | </varlistentry>
|
---|
| 118 |
|
---|
[46a500e] | 119 | <varlistentry id="ctstat">
|
---|
[bdea25ce] | 120 | <term><command>ctstat</command></term>
|
---|
[46a500e] | 121 | <listitem>
|
---|
[89ed081] | 122 | <para>Connection status utility</para>
|
---|
[46a500e] | 123 | <indexterm zone="ch-system-iproute2 ctstat">
|
---|
[005dc3f] | 124 | <primary sortas="b-ctstat">ctstat</primary>
|
---|
[46a500e] | 125 | </indexterm>
|
---|
| 126 | </listitem>
|
---|
| 127 | </varlistentry>
|
---|
| 128 |
|
---|
[2791a8e] | 129 | <varlistentry id="genl">
|
---|
| 130 | <term><command>genl</command></term>
|
---|
| 131 | <listitem>
|
---|
[bd312dc] | 132 | <para>Generic netlink utility frontend</para>
|
---|
[2791a8e] | 133 | <indexterm zone="ch-system-iproute2 genl">
|
---|
| 134 | <primary sortas="b-genl">genl</primary>
|
---|
| 135 | </indexterm>
|
---|
| 136 | </listitem>
|
---|
| 137 | </varlistentry>
|
---|
| 138 |
|
---|
[46a500e] | 139 | <varlistentry id="ifcfg">
|
---|
[bdea25ce] | 140 | <term><command>ifcfg</command></term>
|
---|
[46a500e] | 141 | <listitem>
|
---|
[7bb9fda] | 142 | <para>A shell script wrapper for the <command>ip</command> command
|
---|
| 143 | [Note that it requires the <command>arping</command> and
|
---|
[2ca8941] | 144 | <command>rdisk</command> programs from the
|
---|
[7bb9fda] | 145 | iputils package found at <ulink url="http://www.skbuff.net/iputils/"/>.]</para>
|
---|
[46a500e] | 146 | <indexterm zone="ch-system-iproute2 ifcfg">
|
---|
| 147 | <primary sortas="b-ifcfg">ifcfg</primary>
|
---|
| 148 | </indexterm>
|
---|
| 149 | </listitem>
|
---|
| 150 | </varlistentry>
|
---|
[81fd230] | 151 |
|
---|
| 152 | <varlistentry id="ifstat">
|
---|
[bdea25ce] | 153 | <term><command>ifstat</command></term>
|
---|
[81fd230] | 154 | <listitem>
|
---|
[bdea25ce] | 155 | <para>Shows the interface statistics, including the amount of
|
---|
| 156 | transmitted and received packets by interface</para>
|
---|
[81fd230] | 157 | <indexterm zone="ch-system-iproute2 ifstat">
|
---|
| 158 | <primary sortas="b-ifstat">ifstat</primary>
|
---|
| 159 | </indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="ip">
|
---|
[bdea25ce] | 164 | <term><command>ip</command></term>
|
---|
[81fd230] | 165 | <listitem>
|
---|
| 166 | <para>The main executable. It has several different functions:</para>
|
---|
| 167 |
|
---|
[0090db5] | 168 | <para><command>ip link <replaceable><device></replaceable></command>
|
---|
[bdea25ce] | 169 | allows users to look at the state of devices and to make changes</para>
|
---|
[81fd230] | 170 |
|
---|
| 171 | <para><command>ip addr</command> allows users to look at addresses and
|
---|
[bdea25ce] | 172 | their properties, add new addresses, and delete old ones</para>
|
---|
[81fd230] | 173 |
|
---|
[bdea25ce] | 174 | <para><command>ip neighbor</command> allows users to look at neighbor
|
---|
| 175 | bindings and their properties, add new neighbor entries, and delete
|
---|
| 176 | old ones</para>
|
---|
[81fd230] | 177 |
|
---|
| 178 | <para><command>ip rule</command> allows users to look at the routing
|
---|
[bdea25ce] | 179 | policies and change them</para>
|
---|
[81fd230] | 180 |
|
---|
| 181 | <para><command>ip route</command> allows users to look at the routing
|
---|
[bdea25ce] | 182 | table and change routing table rules</para>
|
---|
[81fd230] | 183 |
|
---|
| 184 | <para><command>ip tunnel</command> allows users to look at the IP
|
---|
[bdea25ce] | 185 | tunnels and their properties, and change them</para>
|
---|
[81fd230] | 186 |
|
---|
| 187 | <para><command>ip maddr</command> allows users to look at the multicast
|
---|
[bdea25ce] | 188 | addresses and their properties, and change them</para>
|
---|
[81fd230] | 189 |
|
---|
| 190 | <para><command>ip mroute</command> allows users to set, change, or
|
---|
[bdea25ce] | 191 | delete the multicast routing</para>
|
---|
[81fd230] | 192 |
|
---|
[cb02946] | 193 | <para><command>ip monitor</command> allows users to continuously monitor
|
---|
[bdea25ce] | 194 | the state of devices, addresses and routes</para>
|
---|
[81fd230] | 195 | <indexterm zone="ch-system-iproute2 ip">
|
---|
| 196 | <primary sortas="b-ip">ip</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
[46a500e] | 201 | <varlistentry id="lnstat">
|
---|
[bdea25ce] | 202 | <term><command>lnstat</command></term>
|
---|
[46a500e] | 203 | <listitem>
|
---|
[7bb9fda] | 204 | <para>Provides Linux network statistics; it is a generalized and more
|
---|
[bdea25ce] | 205 | feature-complete replacement for the old <command>rtstat</command>
|
---|
| 206 | program</para>
|
---|
[46a500e] | 207 | <indexterm zone="ch-system-iproute2 lnstat">
|
---|
[005dc3f] | 208 | <primary sortas="b-lnstat">lnstat</primary>
|
---|
[46a500e] | 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
[81fd230] | 213 | <varlistentry id="nstat">
|
---|
[bdea25ce] | 214 | <term><command>nstat</command></term>
|
---|
[81fd230] | 215 | <listitem>
|
---|
[89ed081] | 216 | <para>Shows network statistics</para>
|
---|
[81fd230] | 217 | <indexterm zone="ch-system-iproute2 nstat">
|
---|
| 218 | <primary sortas="b-nstat">nstat</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | <varlistentry id="routef">
|
---|
[bdea25ce] | 224 | <term><command>routef</command></term>
|
---|
[81fd230] | 225 | <listitem>
|
---|
[bdea25ce] | 226 | <para>A component of <command>ip route</command>. This is for flushing
|
---|
| 227 | the routing tables</para>
|
---|
[81fd230] | 228 | <indexterm zone="ch-system-iproute2 routef">
|
---|
| 229 | <primary sortas="b-routef">routef</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
| 234 | <varlistentry id="routel">
|
---|
[bdea25ce] | 235 | <term><command>routel</command></term>
|
---|
[81fd230] | 236 | <listitem>
|
---|
[bdea25ce] | 237 | <para>A component of <command>ip route</command>. This is for listing
|
---|
| 238 | the routing tables</para>
|
---|
[81fd230] | 239 | <indexterm zone="ch-system-iproute2 routel">
|
---|
| 240 | <primary sortas="b-routel">routel</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
[46a500e] | 245 | <varlistentry id="rtacct">
|
---|
[bdea25ce] | 246 | <term><command>rtacct</command></term>
|
---|
[46a500e] | 247 | <listitem>
|
---|
[bdea25ce] | 248 | <para>Displays the contents of
|
---|
| 249 | <filename>/proc/net/rt_acct</filename></para>
|
---|
[46a500e] | 250 | <indexterm zone="ch-system-iproute2 rtacct">
|
---|
| 251 | <primary sortas="b-rtacct">rtacct</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
| 255 |
|
---|
[81fd230] | 256 | <varlistentry id="rtmon">
|
---|
[bdea25ce] | 257 | <term><command>rtmon</command></term>
|
---|
[81fd230] | 258 | <listitem>
|
---|
[89ed081] | 259 | <para>Route monitoring utility</para>
|
---|
[81fd230] | 260 | <indexterm zone="ch-system-iproute2 rtmon">
|
---|
| 261 | <primary sortas="b-rtmon">rtmon</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
[46a500e] | 266 | <varlistentry id="rtpr">
|
---|
[bdea25ce] | 267 | <term><command>rtpr</command></term>
|
---|
[46a500e] | 268 | <listitem>
|
---|
| 269 | <para>Converts the output of <command>ip -o</command> back into a
|
---|
[bdea25ce] | 270 | readable form</para>
|
---|
[46a500e] | 271 | <indexterm zone="ch-system-iproute2 rtpr">
|
---|
| 272 | <primary sortas="b-rtpr">rtpr</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
[81fd230] | 277 | <varlistentry id="rtstat">
|
---|
[bdea25ce] | 278 | <term><command>rtstat</command></term>
|
---|
[81fd230] | 279 | <listitem>
|
---|
[89ed081] | 280 | <para>Route status utility</para>
|
---|
[81fd230] | 281 | <indexterm zone="ch-system-iproute2 rtstat">
|
---|
| 282 | <primary sortas="b-rtstat">rtstat</primary>
|
---|
| 283 | </indexterm>
|
---|
| 284 | </listitem>
|
---|
| 285 | </varlistentry>
|
---|
| 286 |
|
---|
| 287 | <varlistentry id="ss">
|
---|
[bdea25ce] | 288 | <term><command>ss</command></term>
|
---|
[81fd230] | 289 | <listitem>
|
---|
[bdea25ce] | 290 | <para>Similar to the <command>netstat</command> command; shows active
|
---|
| 291 | connections</para>
|
---|
[81fd230] | 292 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 293 | <primary sortas="b-ss">ss</primary>
|
---|
| 294 | </indexterm>
|
---|
| 295 | </listitem>
|
---|
| 296 | </varlistentry>
|
---|
| 297 |
|
---|
| 298 | <varlistentry id="tc">
|
---|
[bdea25ce] | 299 | <term><command>tc</command></term>
|
---|
[81fd230] | 300 | <listitem>
|
---|
[bdea25ce] | 301 | <para>Traffic Controlling Executable; this is for Quality Of Service
|
---|
| 302 | (QOS) and Class Of Service (COS) implementations</para>
|
---|
[81fd230] | 303 |
|
---|
| 304 | <para><command>tc qdisc</command> allows users to setup the queueing
|
---|
[bdea25ce] | 305 | discipline</para>
|
---|
[81fd230] | 306 |
|
---|
[bdea25ce] | 307 | <para><command>tc class</command> allows users to setup classes based
|
---|
| 308 | on the queuing discipline scheduling</para>
|
---|
[81fd230] | 309 |
|
---|
| 310 | <para><command>tc estimator</command> allows users to estimate the
|
---|
[bdea25ce] | 311 | network flow into a network</para>
|
---|
[81fd230] | 312 |
|
---|
| 313 | <para><command>tc filter</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 314 | packet filtering</para>
|
---|
[81fd230] | 315 |
|
---|
| 316 | <para><command>tc policy</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 317 | policies</para>
|
---|
[81fd230] | 318 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 319 | <primary sortas="b-tc">tc</primary>
|
---|
| 320 | </indexterm>
|
---|
| 321 | </listitem>
|
---|
| 322 | </varlistentry>
|
---|
[bdea25ce] | 323 |
|
---|
[81fd230] | 324 | </variablelist>
|
---|
[bdea25ce] | 325 |
|
---|
[a088964] | 326 | </sect2>
|
---|
[81fd230] | 327 |
|
---|
[bdea25ce] | 328 | </sect1>
|
---|