chapter06/iproute2.xml

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