[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[0590c1b6] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[6c815f9] | 7 | <!ENTITY net-tools-download-http "https://downloads.sourceforge.net/project/net-tools/net-tools-&net-tools-version;.tar.xz">
|
---|
[a3b94fc] | 8 | <!ENTITY net-tools-download-ftp " ">
|
---|
| 9 | <!ENTITY net-tools-md5sum "78aae762c95e2d731faf88d482e4cde5">
|
---|
| 10 | <!ENTITY net-tools-size "228 KB">
|
---|
| 11 | <!ENTITY net-tools-buildsize "7.5 MB">
|
---|
[a71e7697] | 12 | <!ENTITY net-tools-time "less than 0.1 SBU">
|
---|
[0590c1b6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="net-tools" xreflabel="Net-tools-&net-tools-version;">
|
---|
[a3dbd17b] | 16 | <?dbhtml filename="net-tools.html"?>
|
---|
[8d0d2eb] | 17 |
|
---|
| 18 |
|
---|
[a3dbd17b] | 19 | <title>Net-tools-&net-tools-version;</title>
|
---|
[8d0d2eb] | 20 |
|
---|
[a3dbd17b] | 21 | <indexterm zone="net-tools">
|
---|
| 22 | <primary sortas="a-Net-tools">Net-tools</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Net-tools</title>
|
---|
[8d0d2eb] | 27 |
|
---|
[b51fe6e] | 28 | <para>
|
---|
| 29 | The <application>Net-tools</application> package is a collection
|
---|
| 30 | of programs for controlling the network subsystem of the Linux kernel.
|
---|
| 31 | </para>
|
---|
[8d0d2eb] | 32 |
|
---|
[f4734425] | 33 | &lfs122_checked;
|
---|
[2b8421c] | 34 |
|
---|
[a3dbd17b] | 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
[b51fe6e] | 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&net-tools-download-http;"/>
|
---|
| 40 | </para>
|
---|
[a3dbd17b] | 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
[b51fe6e] | 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&net-tools-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
[a3dbd17b] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[b51fe6e] | 48 | <para>
|
---|
| 49 | Download MD5 sum: &net-tools-md5sum;
|
---|
| 50 | </para>
|
---|
[a3dbd17b] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[b51fe6e] | 53 | <para>
|
---|
| 54 | Download size: &net-tools-size;
|
---|
| 55 | </para>
|
---|
[a3dbd17b] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[b51fe6e] | 58 | <para>
|
---|
| 59 | Estimated disk space required: &net-tools-buildsize;
|
---|
| 60 | </para>
|
---|
[a3dbd17b] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[b51fe6e] | 63 | <para>
|
---|
| 64 | Estimated build time: &net-tools-time;
|
---|
| 65 | </para>
|
---|
[2174baa] | 66 | </listitem>
|
---|
[a3dbd17b] | 67 | </itemizedlist>
|
---|
[a3b94fc] | 68 | <!--
|
---|
[49b241a] | 69 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 70 | <itemizedlist spacing="compact">
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Required patch:
|
---|
| 74 | <ulink url="&patch-root;/net-tools-&net-tools-version;-remove_dups-1.patch"/>
|
---|
| 75 | </para>
|
---|
| 76 | </listitem>
|
---|
| 77 | </itemizedlist>
|
---|
[a3b94fc] | 78 | -->
|
---|
[49b241a] | 79 |
|
---|
[061ec9d] | 80 |
|
---|
[a3dbd17b] | 81 | </sect2>
|
---|
[8d0d2eb] | 82 |
|
---|
[a3dbd17b] | 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of Net-tools</title>
|
---|
| 85 |
|
---|
[b51fe6e] | 86 | <para id="net-tools-automate-example" xreflabel="Net-tools">
|
---|
| 87 | The instructions below automate the configuration process by piping
|
---|
[a3b94fc] | 88 | <command>yes</command> to the <command>make</command> command.
|
---|
[b51fe6e] | 89 | If you wish to run the interactive configuration process (by changing
|
---|
[a3b94fc] | 90 | the instruction to just <command>make</command>), but you are
|
---|
[b51fe6e] | 91 | not sure how to answer all the questions, then just accept the defaults.
|
---|
| 92 | This will be just fine in the majority of cases. What you're asked here
|
---|
| 93 | is a bunch of questions about which network protocols you've enabled
|
---|
| 94 | in your kernel. The default answers will enable the tools from this
|
---|
| 95 | package to work with the most common protocols: TCP, PPP, and several
|
---|
| 96 | others. You still need to actually enable these protocols in the
|
---|
| 97 | kernel—what you do here is merely tell the package to include
|
---|
| 98 | support for those protocols in its programs, but it's up to the kernel
|
---|
| 99 | to make the protocols available.
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <note>
|
---|
| 103 | <para>
|
---|
| 104 | This package has several unneeded protocols and hardware device
|
---|
| 105 | specific functions that are obsolete. To only build the minimum needed
|
---|
| 106 | for your system, skip the <command>yes</command> command and answer
|
---|
| 107 | each question interactively. The minimum needed options are 'UNIX
|
---|
| 108 | protocol family' and 'INET (TCP/IP) protocol family'.
|
---|
| 109 | </para>
|
---|
| 110 | </note>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
[a3b94fc] | 113 | For this package, we use the DESTDIR method of installation in order
|
---|
| 114 | to easily remove files from the build that overwrite those that we want
|
---|
| 115 | to keep or are not appropriate for our system.
|
---|
[b51fe6e] | 116 | </para>
|
---|
| 117 |
|
---|
[6c815f9] | 118 | <!-- When building with MAKEFLAGS set to a -j value higher than 1, a race
|
---|
| 119 | condition will occur. -renodr -->
|
---|
| 120 |
|
---|
[b51fe6e] | 121 | <para>
|
---|
| 122 | Install <application>Net-tools</application> by running the
|
---|
| 123 | following commands:
|
---|
| 124 | </para>
|
---|
[a3dbd17b] | 125 |
|
---|
[a3b94fc] | 126 | <screen><userinput>export BINDIR='/usr/bin' SBINDIR='/usr/bin' &&
|
---|
[6c815f9] | 127 | yes "" | make -j1 &&
|
---|
| 128 | make DESTDIR=$PWD/install -j1 install &&
|
---|
[a3b94fc] | 129 | rm install/usr/bin/{nis,yp}domainname &&
|
---|
[beea728] | 130 | rm install/usr/bin/{hostname,dnsdomainname,domainname,ifconfig} &&
|
---|
[a3b94fc] | 131 | rm -r install/usr/share/man/man1 &&
|
---|
[beea728] | 132 | rm install/usr/share/man/man8/ifconfig.8 &&
|
---|
[a3b94fc] | 133 | unset BINDIR SBINDIR</userinput></screen>
|
---|
[46441976] | 134 |
|
---|
[b51fe6e] | 135 | <para>
|
---|
| 136 | This package does not come with a test suite.
|
---|
| 137 | </para>
|
---|
[46441976] | 138 |
|
---|
[b51fe6e] | 139 | <para>
|
---|
| 140 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 141 | </para>
|
---|
[46441976] | 142 |
|
---|
[a3b94fc] | 143 | <screen role='root'><userinput>chown -R root:root install &&
|
---|
| 144 | cp -a install/* /</userinput></screen>
|
---|
[8d0d2eb] | 145 |
|
---|
[a3dbd17b] | 146 | </sect2>
|
---|
[8d0d2eb] | 147 |
|
---|
[a3dbd17b] | 148 | <sect2 role="commands">
|
---|
| 149 | <title>Command Explanations</title>
|
---|
[851ed2f] | 150 |
|
---|
[0ea195f4] | 151 | <para>
|
---|
[a3b94fc] | 152 | <command>export BINDIR='/usr/bin' SBINDIR='/usr/bin'</command>:
|
---|
| 153 | Ensure the executables are installed in the correct location.
|
---|
[0ea195f4] | 154 | </para>
|
---|
| 155 |
|
---|
[b51fe6e] | 156 | <para>
|
---|
[a3b94fc] | 157 | <command>yes "" | make </command>: Piping <command>yes</command>
|
---|
| 158 | to <command>make config</command> skips the interactive configuration and
|
---|
| 159 | accepts the defaults.
|
---|
[8617f6dd] | 160 | </para>
|
---|
| 161 |
|
---|
[b51fe6e] | 162 | <para>
|
---|
[a3b94fc] | 163 | <command>rm ...</command>: Remove unneeded programs and man pages.
|
---|
[b51fe6e] | 164 | </para>
|
---|
[8d0d2eb] | 165 |
|
---|
[a3dbd17b] | 166 | </sect2>
|
---|
[8d0d2eb] | 167 |
|
---|
[a3dbd17b] | 168 | <sect2 role="content">
|
---|
| 169 | <title>Contents</title>
|
---|
[8d0d2eb] | 170 |
|
---|
[a3dbd17b] | 171 | <segmentedlist>
|
---|
| 172 | <segtitle>Installed Programs</segtitle>
|
---|
| 173 | <segtitle>Installed Libraries</segtitle>
|
---|
| 174 | <segtitle>Installed Directories</segtitle>
|
---|
[8d0d2eb] | 175 |
|
---|
[a3dbd17b] | 176 | <seglistitem>
|
---|
[8558044] | 177 | <seg>arp,
|
---|
| 178 | ipmaddr,
|
---|
| 179 | iptunnel,
|
---|
| 180 | mii-tool,
|
---|
| 181 | nameif,
|
---|
[a3b94fc] | 182 | netstat,
|
---|
[8558044] | 183 | plipconfig,
|
---|
| 184 | rarp,
|
---|
| 185 | route, and
|
---|
[a3b94fc] | 186 | slattach
|
---|
[49b241a] | 187 | </seg>
|
---|
[a3dbd17b] | 188 | <seg>None</seg>
|
---|
[46441976] | 189 | <seg>None</seg>
|
---|
[a3dbd17b] | 190 | </seglistitem>
|
---|
| 191 | </segmentedlist>
|
---|
[8d0d2eb] | 192 |
|
---|
[a3dbd17b] | 193 | <variablelist>
|
---|
| 194 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 195 | <?dbfo list-presentation="list"?>
|
---|
| 196 | <?dbhtml list-presentation="table"?>
|
---|
[8d0d2eb] | 197 |
|
---|
[a3dbd17b] | 198 | <varlistentry id="arp">
|
---|
| 199 | <term><command>arp</command></term>
|
---|
| 200 | <listitem>
|
---|
[b51fe6e] | 201 | <para>
|
---|
| 202 | is used to manipulate the kernel's ARP cache, usually
|
---|
[4c24eb0a] | 203 | to add or delete an entry, or to dump the entire cache
|
---|
[b51fe6e] | 204 | </para>
|
---|
[a3dbd17b] | 205 | <indexterm zone="net-tools arp">
|
---|
| 206 | <primary sortas="b-arp">arp</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
[8d0d2eb] | 210 |
|
---|
[a3dbd17b] | 211 | <varlistentry id="ipmaddr">
|
---|
| 212 | <term><command>ipmaddr</command></term>
|
---|
| 213 | <listitem>
|
---|
[b51fe6e] | 214 | <para>
|
---|
[4c24eb0a] | 215 | adds, deletes and shows an interface's multicast addresses
|
---|
[b51fe6e] | 216 | </para>
|
---|
[a3dbd17b] | 217 | <indexterm zone="net-tools ipmaddr">
|
---|
| 218 | <primary sortas="b-ipmaddr">ipmaddr</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
[8d0d2eb] | 222 |
|
---|
[a3dbd17b] | 223 | <varlistentry id="iptunnel">
|
---|
| 224 | <term><command>iptunnel</command></term>
|
---|
| 225 | <listitem>
|
---|
[b51fe6e] | 226 | <para>
|
---|
[4c24eb0a] | 227 | adds, changes, deletes and shows an interface's tunnels
|
---|
[b51fe6e] | 228 | </para>
|
---|
[a3dbd17b] | 229 | <indexterm zone="net-tools iptunnel">
|
---|
| 230 | <primary sortas="b-iptunnel">iptunnel</primary>
|
---|
| 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
[8d0d2eb] | 234 |
|
---|
[a3dbd17b] | 235 | <varlistentry id="mii-tool">
|
---|
| 236 | <term><command>mii-tool</command></term>
|
---|
| 237 | <listitem>
|
---|
[b51fe6e] | 238 | <para>
|
---|
| 239 | checks or sets the status of a network interface's Media
|
---|
[4c24eb0a] | 240 | Independent Interface (MII) unit
|
---|
[b51fe6e] | 241 | </para>
|
---|
[a3dbd17b] | 242 | <indexterm zone="net-tools mii-tool">
|
---|
| 243 | <primary sortas="b-mii-tool">mii-tool</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
[8d0d2eb] | 247 |
|
---|
[a3dbd17b] | 248 | <varlistentry id="nameif">
|
---|
| 249 | <term><command>nameif</command></term>
|
---|
| 250 | <listitem>
|
---|
[b51fe6e] | 251 | <para>
|
---|
[4c24eb0a] | 252 | names network interfaces based on MAC addresses
|
---|
[b51fe6e] | 253 | </para>
|
---|
[a3dbd17b] | 254 | <indexterm zone="net-tools nameif">
|
---|
| 255 | <primary sortas="b-nameif">nameif</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
[8d0d2eb] | 259 |
|
---|
[a3dbd17b] | 260 | <varlistentry id="netstat">
|
---|
| 261 | <term><command>netstat</command></term>
|
---|
| 262 | <listitem>
|
---|
[b51fe6e] | 263 | <para>
|
---|
| 264 | is used to report network connections, routing tables, and
|
---|
[4c24eb0a] | 265 | interface statistics
|
---|
[b51fe6e] | 266 | </para>
|
---|
[a3dbd17b] | 267 | <indexterm zone="net-tools netstat">
|
---|
| 268 | <primary sortas="b-netstat">netstat</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
[a3b94fc] | 272 |
|
---|
[a3dbd17b] | 273 | <varlistentry id="plipconfig">
|
---|
| 274 | <term><command>plipconfig</command></term>
|
---|
| 275 | <listitem>
|
---|
[b51fe6e] | 276 | <para>
|
---|
| 277 | is used to fine tune the PLIP device parameters, to
|
---|
[4c24eb0a] | 278 | improve its performance
|
---|
[b51fe6e] | 279 | </para>
|
---|
[a3dbd17b] | 280 | <indexterm zone="net-tools plipconfig">
|
---|
| 281 | <primary sortas="b-plipconfig">plipconfig</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
[8d0d2eb] | 285 |
|
---|
[a3dbd17b] | 286 | <varlistentry id="rarp">
|
---|
| 287 | <term><command>rarp</command></term>
|
---|
| 288 | <listitem>
|
---|
[b51fe6e] | 289 | <para>
|
---|
[4c24eb0a] | 290 | is used to manipulate the kernel's RARP table
|
---|
[b51fe6e] | 291 | </para>
|
---|
[a3dbd17b] | 292 | <indexterm zone="net-tools rarp">
|
---|
| 293 | <primary sortas="b-rarp">rarp</primary>
|
---|
| 294 | </indexterm>
|
---|
| 295 | </listitem>
|
---|
| 296 | </varlistentry>
|
---|
[8d0d2eb] | 297 |
|
---|
[a3dbd17b] | 298 | <varlistentry id="route">
|
---|
| 299 | <term><command>route</command></term>
|
---|
| 300 | <listitem>
|
---|
[b51fe6e] | 301 | <para>
|
---|
[4c24eb0a] | 302 | is used to manipulate the IP routing table
|
---|
[b51fe6e] | 303 | </para>
|
---|
[a3dbd17b] | 304 | <indexterm zone="net-tools route">
|
---|
| 305 | <primary sortas="b-route">route</primary>
|
---|
| 306 | </indexterm>
|
---|
| 307 | </listitem>
|
---|
| 308 | </varlistentry>
|
---|
[8d0d2eb] | 309 |
|
---|
[a3dbd17b] | 310 | <varlistentry id="slattach">
|
---|
| 311 | <term><command>slattach</command></term>
|
---|
| 312 | <listitem>
|
---|
[b51fe6e] | 313 | <para>
|
---|
| 314 | attaches a network interface to a serial line. This allows you to
|
---|
| 315 | use normal terminal lines for point-to-point links to others
|
---|
[4c24eb0a] | 316 | computers
|
---|
[b51fe6e] | 317 | </para>
|
---|
[a3dbd17b] | 318 | <indexterm zone="net-tools slattach">
|
---|
| 319 | <primary sortas="b-slattach">slattach</primary>
|
---|
| 320 | </indexterm>
|
---|
| 321 | </listitem>
|
---|
| 322 | </varlistentry>
|
---|
| 323 | </variablelist>
|
---|
[8d0d2eb] | 324 |
|
---|
[a3dbd17b] | 325 | </sect2>
|
---|
[8d0d2eb] | 326 |
|
---|
[0590c1b6] | 327 | </sect1>
|
---|