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