source: basicnet/netprogs/net-tools.xml@ f420f67

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY net-tools-download-http "http://www.tazenda.demon.co.uk/phil/net-tools/net-tools-&net-tools-version;.tar.bz2">
  <!ENTITY net-tools-download-ftp  "ftp://ftp.ibiblio.org/pub/Linux/distributions/rootlinux/rootlinux-1.3/source/base/net-tools/net-tools-&net-tools-version;.tar.gz">
  <!ENTITY net-tools-md5sum-http   "888774accab40217dde927e21979c165">
  <!ENTITY net-tools-md5sum-ftp    "e1e83a4d4cdd72d35bcf90d76a16206f">
  <!ENTITY net-tools-size          "194 KB">
  <!ENTITY net-tools-buildsize     "4.3 MB">
  <!ENTITY net-tools-time          "0.10 SBU">
  <!ENTITY lfs-coreutils-version   "5.2.1">
]>

<sect1 id="net-tools" xreflabel="Net-tools-&net-tools-version;">
  <?dbhtml filename="net-tools.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Net-tools-&net-tools-version;</title>

  <indexterm zone="net-tools">
    <primary sortas="a-Net-tools">Net-tools</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Net-tools</title>

    <para>The <application>Net-tools</application> package is a collection
    of programs for controlling the network subsystem of the Linux
    kernel.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&net-tools-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&net-tools-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum (HTTP): &net-tools-md5sum-http;</para>
      </listitem>
      <listitem>
        <para>Download MD5 sum (FTP): &net-tools-md5sum-ftp;</para>
      </listitem>
      <listitem>
        <para>Download size: &net-tools-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &net-tools-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &net-tools-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required Patch (if compiled using 
        <application>GCC</application>-3.4.x): <ulink
        url="&patch-root;/net-tools-&net-tools-version;-gcc34-3.patch"/></para>
      </listitem>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/net-tools-&net-tools-version;-kernel_headers-2.patch"/></para>
      </listitem>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/net-tools-&net-tools-version;-mii_ioctl-1.patch"/></para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Net-tools</title>

    <note>
      <para>The <application>Net-tools</application> package installs a 
      <command>hostname</command> program which will overwrite the existing program 
      installed by <application>Coreutils</application> during a base 
      LFS installation. If, for whatever reason, you need to 
      reinstall the <application>Coreutils</application> package after installing 
      <application>Net-tools</application>, you should use the 
      <filename>coreutils-&lfs-coreutils-version;-suppress_hostname_uptime_kill_su-1.patch</filename>
      patch if you wish to preserve the <application>Net-tools</application>
      <command>hostname</command> program.</para>
    </note>

    <para>If you don't know what to answer to all the questions asked during
    the <command>make config</command> phase below, then just accept the
    defaults (the build command below automates this). This will be just fine 
    in the majority of cases. What you're
    asked here is a bunch of questions about which network protocols you've
    enabled in your kernel. The default answers will enable the tools from
    this package to work with the most common protocols:
    TCP, PPP, and several others. You
    still need to actually enable these protocols in the kernel&mdash;what you
    do here is merely telling the package to include support for those
    protocols in its programs, but it's up to the kernel to make the
    protocols available.</para>

    <para>Install <application>Net-tools</application> by running the
    following commands:</para>

<screen><userinput>patch -Np1 -i ../net-tools-&net-tools-version;-gcc34-3.patch &amp;&amp;
patch -Np1 -i ../net-tools-&net-tools-version;-kernel_headers-2.patch &amp;&amp;
patch -Np1 -i ../net-tools-&net-tools-version;-mii_ioctl-1.patch &amp;&amp;
yes "" | make config &amp;&amp;
sed -i -e 's|HAVE_IP_TOOLS 0|HAVE_IP_TOOLS 1|g' \
       -e 's|HAVE_MII 0|HAVE_MII 1|g' config.h &amp;&amp;
sed -i -e 's|# HAVE_IP_TOOLS=0|HAVE_IP_TOOLS=1|g' \
       -e 's|# HAVE_MII=0|HAVE_MII=1|g' config.make &amp;&amp;
make &amp;&amp;
make update</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>yes "" | make config</command>: Piping <command>yes</command>
    to <command>make config</command> skips the interactive configuration and
    accepts the defaults.</para>

    <para><command>sed -i -e ...</command>: These two <command>sed</command>s
    change the configuration files to force building the 
    <command>ipmaddr</command>, <command>iptunnel</command> and 
    <command>mii-tool</command> programs.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>arp, dnsdomainname, domainname, hostname, 
        ifconfig, ipmaddr, iptunnel, mii-tool, nameif, netstat, 
        nisdomainname, plipconfig, rarp, route, slattach, and 
        ypdomainname</seg>
        <seg>None</seg>
        <seg>Not determined at this time</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="arp">
        <term><command>arp</command></term>
        <listitem>
          <para>is used to manipulate the kernel's ARP cache, usually
          to add or delete an entry, or to dump the entire cache.</para>
          <indexterm zone="net-tools arp">
            <primary sortas="b-arp">arp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dnsdomainname">
        <term><command>dnsdomainname</command></term>
        <listitem>
          <para>reports the system's DNS domain name.</para>
          <indexterm zone="net-tools dnsdomainname">
            <primary sortas="b-dnsdomainname">dnsdomainname</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="domainname">
        <term><command>domainname</command></term>
        <listitem>
          <para>reports or sets the system's NIS/YP domain name.</para>
          <indexterm zone="net-tools domainname">
            <primary sortas="b-domainname">domainname</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="hostname">
        <term><command>hostname</command></term>
        <listitem>
          <para>reports or sets the name of the current host system.</para>
          <indexterm zone="net-tools hostname">
            <primary sortas="b-hostname">hostname</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ifconfig">
        <term><command>ifconfig</command></term>
        <listitem>
          <para>is the main utility for configuring network interfaces.</para>
          <indexterm zone="net-tools ifconfig">
            <primary sortas="b-ifconfig">ifconfig</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ipmaddr">
        <term><command>ipmaddr</command></term>
        <listitem>
          <para>adds, deletes and shows an interface's multicast addresses.</para>
          <indexterm zone="net-tools ipmaddr">
            <primary sortas="b-ipmaddr">ipmaddr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="iptunnel">
        <term><command>iptunnel</command></term>
        <listitem>
          <para>adds, changes, deletes and shows an interface's tunnels.</para>
          <indexterm zone="net-tools iptunnel">
            <primary sortas="b-iptunnel">iptunnel</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mii-tool">
        <term><command>mii-tool</command></term>
        <listitem>
          <para>checks or sets the status of a network interface's Media Independent 
          Interface (MII) unit.</para>
          <indexterm zone="net-tools mii-tool">
            <primary sortas="b-mii-tool">mii-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nameif">
        <term><command>nameif</command></term>
        <listitem>
          <para>names network interfaces based on MAC addresses.</para>
          <indexterm zone="net-tools nameif">
            <primary sortas="b-nameif">nameif</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="netstat">
        <term><command>netstat</command></term>
        <listitem>
          <para>is used to report network connections, routing tables, and interface
          statistics.</para>
          <indexterm zone="net-tools netstat">
            <primary sortas="b-netstat">netstat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nisdomainname">
        <term><command>nisdomainname</command></term>
        <listitem>
          <para>does the same as <command>domainname</command>.</para>
          <indexterm zone="net-tools nisdomainname">
            <primary sortas="b-nisdomainname">nisdomainname</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="plipconfig">
        <term><command>plipconfig</command></term>
        <listitem>
          <para>is used to fine tune the PLIP device parameters, to
          improve its performance.</para>
          <indexterm zone="net-tools plipconfig">
            <primary sortas="b-plipconfig">plipconfig</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rarp">
        <term><command>rarp</command></term>
        <listitem>
          <para>is used to manipulate the kernel's RARP table.</para>
          <indexterm zone="net-tools rarp">
            <primary sortas="b-rarp">rarp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="route">
        <term><command>route</command></term>
        <listitem>
          <para>is used to manipulate the IP routing table.</para>
          <indexterm zone="net-tools route">
            <primary sortas="b-route">route</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="slattach">
        <term><command>slattach</command></term>
        <listitem>
          <para>attaches a network interface to a serial line. This allows you to use
          normal terminal lines for point-to-point links to other computers.</para>
          <indexterm zone="net-tools slattach">
            <primary sortas="b-slattach">slattach</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ypdomainname">
        <term><command>ypdomainname</command></term>
        <listitem>
          <para>does the same as <command>domainname</command>.</para>
          <indexterm zone="net-tools ypdomainname">
            <primary sortas="b-ypdomainname">ypdomainname</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>