glfs/basicnet/netprogs/net-tools.xml

<?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;

  <!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  " ">
  <!ENTITY net-tools-size          "194 KB">
  <!ENTITY net-tools-buildsize     "9.4 MB">
  <!ENTITY net-tools-time          "0.10 SBU">
]>

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


<sect2>
<title>Introduction to <application>Net-tools</application></title>

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

<sect3><title>Package information</title>
<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 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>
</sect3>

<!--
<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Required Patch: <ulink
url="&patch-root;/net-tools-&net-tools-version;-gcc34-3.patch"/></para></listitem>
</itemizedlist></sect3>
-->

</sect2>

<sect2>
<title>Installation of <application>Net-tools</application></title>

<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. 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:
<acronym>TCP</acronym>, <acronym>PPP</acronym>, 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>This package has issues with being compiled by
<application><acronym>GCC</acronym></application> 3.4, which we fix by
applying the following patch:</para>

<screen><userinput><command>patch -Np1 -i ../net-tools-&net-tools-version;-gcc34-3.patch</command></userinput></screen>

<para>Fix an issue that arises when building against Linux 2.6:</para>

<screen><userinput><command>sed -i 's@x25_address@struct &amp;@' lib/x25_sr.c</command></userinput></screen>
-->

<para>Now prepare <application>Net-tools</application> for compilation
(if you intend to accept the defaults, you can skip all the questions by
running <command>yes "" | make config</command> instead):</para>

<screen><userinput><command>make config</command></userinput></screen>

<para>Compile the package:</para>

<screen><userinput><command>make</command></userinput></screen>

<para>Now install it:</para>

<screen><userinput><command>make update</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Net-tools</application> package contains
<command>arp</command>,
<command>dnsdomainname</command> (link to <command>hostname</command>),
<command>domainname</command> (link to <command>hostname</command>),
<command>hostname</command>,
<command>ifconfig</command>,
<command>nameif</command>,
<command>netstat</command>,
<command>nisdomainname</command> (link to <command>hostname</command>),
<command>plipconfig</command>,
<command>rarp</command>,
<command>route</command>,
<command>slattach</command> and
<command>ypdomainname</command> (link to <command>hostname</command>).</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>arp</title>
<para><command>arp</command>
is used to manipulate the kernel's <acronym>ARP</acronym> cache, usually
to add or delete an entry, or to dump the entire cache.
</para></sect3>

<sect3><title>dnsdomainname</title>
<para><command>dnsdomainname</command>
reports the system's <acronym>DNS</acronym> domain name.
</para></sect3>

<sect3><title>domainname</title>
<para><command>domainname</command>
reports or sets the system's
<acronym>NIS</acronym>/<acronym>YP</acronym> domain name.
</para></sect3>

<sect3><title>hostname</title>
<para><command>hostname</command>
reports or sets the name of the current host system.
</para></sect3>

<sect3><title>ifconfig</title>
<para><command>ifconfig</command>
is the main utility for configuring network interfaces.
</para></sect3>

<sect3><title>nameif</title>
<para><command>nameif</command>
names network interfaces based on <acronym>MAC</acronym> addresses.
</para></sect3>

<sect3><title>netstat</title>
<para><command>netstat</command>
is used to report network connections, routing tables, and interface
statistics.
</para></sect3>

<sect3><title>nisdomainname</title>
<para><command>nisdomainname</command>
does the same as <command>domainname</command>.
</para></sect3>

<sect3><title>plipconfig</title>
<para><command>plipconfig</command>
is used to fine tune the <acronym>PLIP</acronym> device parameters, to
improve its performance.
</para></sect3>

<sect3><title>rarp</title>
<para><command>rarp</command>
is used to manipulate the kernel's <acronym>RARP</acronym> table.
</para></sect3>

<sect3><title>route</title>
<para><command>route</command>
is used to manipulate the <acronym>IP</acronym> routing table.
</para></sect3>

<sect3><title>slattach</title>
<para><command>slattach</command>
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></sect3>

<sect3><title>ypdomainname</title>
<para><command>ypdomainname</command>
does the same as <command>domainname</command>.
</para></sect3>

</sect2>

</sect1>