source: chapter06/iproute2.xml@ 30c872d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<sect1 id="ch-system-iproute2" xreflabel="IProute2" role="wrap">
  <title>Iproute2-&iproute2-version;</title>
<?dbhtml filename="iproute2.html"?>
  <indexterm zone="ch-system-iproute2">
    <primary sortas="a-iproute2">iproute2</primary>
  </indexterm>
  <sect2 role="package">
    <title/>
    <para>The iproute2 package contains programs for basic and advanced
          IPV4-based networking.
    </para>
    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>
      <seglistitem>
        <seg>0.1 SBU</seg>
        <seg>.6 MB</seg>
      </seglistitem>
    </segmentedlist>
    <segmentedlist>
      <segtitle>iproute2 installation depends on</segtitle>
      <seglistitem>
        <seg>sed, GCC, Glibc, Make, Linux-Headers</seg>
      </seglistitem>
    </segmentedlist>
  </sect2>
  <sect2 role="installation">
    <title>Installation of iproute2</title>
    <para>The <command>arpd</command> binary included in this package is
          dependent on Berkeley DB.  As <command>arpd</command> is not a very
          common requirement on a base Linux system we remove the dependency on
          Berkeley DB by applying the patch using the command below.  If you
          need the <command>arpd</command> binary, then instructions for
          compiling Berkeley DB can be found in the <ulink
          url="http://www.linuxfromscratch.org/blfs/view/cvs/content/databases.html#db">BLFS book</ulink>.
    </para>

    <screen><userinput>patch -Np1 -i ../iproute2-&iproute2-patch-version;-remove_db-1.patch</userinput></screen>

    <para>The patch below fixes the issue with the newer versions of findutils,
    the issue will give an error message it options are not in the proper order.
    This patch corrects this issue for IPRoute2.</para>

    <screen><userinput>patch -Np1 -i ../iproute2-&iproute2-patch-version;-find_update-1.patch</userinput></screen>

    <para>Prepare iproute2 for compilation:</para>
    <screen> <userinput>./configure </userinput></screen>

    <para>Compile the package:</para>

    <screen><userinput>make SBINDIR=/sbin</userinput></screen>

    <variablelist>
    <varlistentry>
    <term><parameter>SBINDIR=/sbin</parameter></term>
    <listitem><para>This makes sure that the iproute2 binaries will install into
      <filename class="directory">/sbin</filename>.  This is the correct
      location according to the FHS, as some of the iproute2 binaries are used
      in our bootscripts.</para>
    </listitem>
    </varlistentry>
    </variablelist>

    <para>Now install it:</para>

    <screen><userinput>make install SBINDIR=/sbin</userinput></screen>
  </sect2>

  <sect2 id="contents-iproute2" role="content">
    <title>Contents of iproute2</title>
    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <seglistitem>
        <seg>ifstat, ip, nstat, routef, routel, rtmon, rtstat, ss, and tc.</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <title>Short descriptions</title>

      <varlistentry id="ifstat">
        <term>
          <command>ifstat</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 ifstat">
            <primary sortas="b-ifstat">ifstat</primary>
          </indexterm>
          <para>shows the interfaces statistics. Shows the amount of transmitted
                and received packages by interface</para>
        </listitem>
      </varlistentry>

      <varlistentry id="ip">
        <term>
          <command>ip</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 ip">
            <primary sortas="b-ip">ip</primary>
          </indexterm>

          <para>is the main executable. Has several different functions.</para>

          <para><command>ip link <replaceable>[device]</replaceable></command>
                allows you to look at the state of devices and to change it.
          </para>

          <para><command>ip addr</command> allows you to look at addresses and
                their properties, add new addresses and to delete old ones.
          </para>

          <para><command>ip neighbor</command> allows you to look at neighbour
                bindings and their properties, add new neighbour entries and to
                delete old ones.
          </para>

          <para><command>ip rule</command> allows you to look at the routing
                policies and change them.
          </para>

          <para><command>ip route</command> allows you to look at the routing
                table and change routing table rules.
          </para>

          <para><command>ip tunnel</command> allows you to look at the ip
                tunnels and their properties, and change them.
          </para>

          <para><command>ip maddr</command> allows you to look at the multicast
                addresses and their properties, and change them.
          </para>

          <para><command>ip mroute</command> allows you to set, change, or
                delete the mutlicast routing.
          </para>

          <para><command>ip monitor</command> allows you to monitor the state of
                devices, addresses and routes continuously.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry id="nstat">
        <term>
          <command>nstat</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 nstat">
            <primary sortas="b-nstat">nstat</primary>
          </indexterm>
          <para>Shows network statistics</para>
        </listitem>
      </varlistentry>

      <varlistentry id="routef">
        <term>
          <command>routef</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 routef">
            <primary sortas="b-routef">routef</primary>
          </indexterm>
          <para>A component of ip route. This is for flushing the routing
                tables.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry id="routel">
        <term>
          <command>routel</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 routel">
            <primary sortas="b-routel">routel</primary>
          </indexterm>
          <para>A component of ip route. This is for listing the routing
                tables.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry id="rtmon">
        <term>
          <command>rtmon</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 rtmon">
            <primary sortas="b-rtmon">rtmon</primary>
          </indexterm>
          <para>Route Monitoring Utility.</para>
        </listitem>
      </varlistentry>

      <varlistentry id="rtstat">
        <term>
          <command>rtstat</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 rtstat">
            <primary sortas="b-rtstat">rtstat</primary>
          </indexterm>
          <para>Route Status Utility</para>
        </listitem>
      </varlistentry>

      <varlistentry id="ss">
        <term>
          <command>ss</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 ss">
            <primary sortas="b-ss">ss</primary>
          </indexterm>
          <para>Similar to the netstat command. Shows active connections.</para>
        </listitem>
      </varlistentry>

      <varlistentry id="tc">
        <term>
          <command>tc</command>
        </term>
        <listitem>
          <indexterm zone="ch-system-iproute2 ss">
            <primary sortas="b-tc">tc</primary>
          </indexterm>
          <para>Traffic Controlling Executable. This is for QOS/COS
                implementations.
          </para>

          <para><command>tc qdisc</command> allows you to setup the queueing
                discipline.
          </para>

          <para><command>tc class</command> allows you to setup classes based on
                the queuing discipline scheduling.
          </para>

          <para><command>tc estimator</command> allows you to estimate the
                network flow into a network.
          </para>

          <para><command>tc filter</command> allows you to setup the QOS/COS
                packet filtering.
          </para>

          <para><command>tc policy</command> allows you to setup the QOS/COS
                policies.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>