source: networking/netprogs/net-tools.xml

trunk
Last change on this file was 5d0e7b8, checked in by Douglas R. Reno <renodr@…>, 2 months ago

A bunch of tags

  • Property mode set to 100644
File size: 10.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 <!ENTITY net-tools-download-http "https://downloads.sourceforge.net/project/net-tools/net-tools-&net-tools-version;.tar.xz">
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">
12 <!ENTITY net-tools-time "less than 0.1 SBU">
13]>
14
15<sect1 id="net-tools" xreflabel="Net-tools-&net-tools-version;">
16 <?dbhtml filename="net-tools.html"?>
17
18
19 <title>Net-tools-&net-tools-version;</title>
20
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>
27
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>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&net-tools-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&net-tools-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &net-tools-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &net-tools-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &net-tools-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &net-tools-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68<!--
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>
78-->
79
80
81 </sect2>
82
83 <sect2 role="installation">
84 <title>Installation of Net-tools</title>
85
86 <para id="net-tools-automate-example" xreflabel="Net-tools">
87 The instructions below automate the configuration process by piping
88 <command>yes</command> to the <command>make</command> command.
89 If you wish to run the interactive configuration process (by changing
90 the instruction to just <command>make</command>), but you are
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&mdash;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>
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.
116 </para>
117
118 <!-- When building with MAKEFLAGS set to a -j value higher than 1, a race
119 condition will occur. -renodr -->
120
121 <para>
122 Install <application>Net-tools</application> by running the
123 following commands:
124 </para>
125
126<screen><userinput>export BINDIR='/usr/bin' SBINDIR='/usr/bin' &amp;&amp;
127yes "" | make -j1 &amp;&amp;
128make DESTDIR=$PWD/install -j1 install &amp;&amp;
129rm install/usr/bin/{nis,yp}domainname &amp;&amp;
130rm install/usr/bin/{hostname,dnsdomainname,domainname,ifconfig} &amp;&amp;
131rm -r install/usr/share/man/man1 &amp;&amp;
132rm install/usr/share/man/man8/ifconfig.8 &amp;&amp;
133unset BINDIR SBINDIR</userinput></screen>
134
135 <para>
136 This package does not come with a test suite.
137 </para>
138
139 <para>
140 Now, as the <systemitem class="username">root</systemitem> user:
141 </para>
142
143<screen role='root'><userinput>chown -R root:root install &amp;&amp;
144cp -a install/* /</userinput></screen>
145
146 </sect2>
147
148 <sect2 role="commands">
149 <title>Command Explanations</title>
150
151 <para>
152 <command>export BINDIR='/usr/bin' SBINDIR='/usr/bin'</command>:
153 Ensure the executables are installed in the correct location.
154 </para>
155
156 <para>
157 <command>yes "" | make </command>: Piping <command>yes</command>
158 to <command>make config</command> skips the interactive configuration and
159 accepts the defaults.
160 </para>
161
162 <para>
163 <command>rm ...</command>: Remove unneeded programs and man pages.
164 </para>
165
166 </sect2>
167
168 <sect2 role="content">
169 <title>Contents</title>
170
171 <segmentedlist>
172 <segtitle>Installed Programs</segtitle>
173 <segtitle>Installed Libraries</segtitle>
174 <segtitle>Installed Directories</segtitle>
175
176 <seglistitem>
177 <seg>arp,
178 ipmaddr,
179 iptunnel,
180 mii-tool,
181 nameif,
182 netstat,
183 plipconfig,
184 rarp,
185 route, and
186 slattach
187 </seg>
188 <seg>None</seg>
189 <seg>None</seg>
190 </seglistitem>
191 </segmentedlist>
192
193 <variablelist>
194 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
195 <?dbfo list-presentation="list"?>
196 <?dbhtml list-presentation="table"?>
197
198 <varlistentry id="arp">
199 <term><command>arp</command></term>
200 <listitem>
201 <para>
202 is used to manipulate the kernel's ARP cache, usually
203 to add or delete an entry, or to dump the entire cache
204 </para>
205 <indexterm zone="net-tools arp">
206 <primary sortas="b-arp">arp</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="ipmaddr">
212 <term><command>ipmaddr</command></term>
213 <listitem>
214 <para>
215 adds, deletes and shows an interface's multicast addresses
216 </para>
217 <indexterm zone="net-tools ipmaddr">
218 <primary sortas="b-ipmaddr">ipmaddr</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="iptunnel">
224 <term><command>iptunnel</command></term>
225 <listitem>
226 <para>
227 adds, changes, deletes and shows an interface's tunnels
228 </para>
229 <indexterm zone="net-tools iptunnel">
230 <primary sortas="b-iptunnel">iptunnel</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="mii-tool">
236 <term><command>mii-tool</command></term>
237 <listitem>
238 <para>
239 checks or sets the status of a network interface's Media
240 Independent Interface (MII) unit
241 </para>
242 <indexterm zone="net-tools mii-tool">
243 <primary sortas="b-mii-tool">mii-tool</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="nameif">
249 <term><command>nameif</command></term>
250 <listitem>
251 <para>
252 names network interfaces based on MAC addresses
253 </para>
254 <indexterm zone="net-tools nameif">
255 <primary sortas="b-nameif">nameif</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="netstat">
261 <term><command>netstat</command></term>
262 <listitem>
263 <para>
264 is used to report network connections, routing tables, and
265 interface statistics
266 </para>
267 <indexterm zone="net-tools netstat">
268 <primary sortas="b-netstat">netstat</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="plipconfig">
274 <term><command>plipconfig</command></term>
275 <listitem>
276 <para>
277 is used to fine tune the PLIP device parameters, to
278 improve its performance
279 </para>
280 <indexterm zone="net-tools plipconfig">
281 <primary sortas="b-plipconfig">plipconfig</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="rarp">
287 <term><command>rarp</command></term>
288 <listitem>
289 <para>
290 is used to manipulate the kernel's RARP table
291 </para>
292 <indexterm zone="net-tools rarp">
293 <primary sortas="b-rarp">rarp</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="route">
299 <term><command>route</command></term>
300 <listitem>
301 <para>
302 is used to manipulate the IP routing table
303 </para>
304 <indexterm zone="net-tools route">
305 <primary sortas="b-route">route</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="slattach">
311 <term><command>slattach</command></term>
312 <listitem>
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
316 computers
317 </para>
318 <indexterm zone="net-tools slattach">
319 <primary sortas="b-slattach">slattach</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323 </variablelist>
324
325 </sect2>
326
327</sect1>
Note: See TracBrowser for help on using the repository browser.