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