source: networking/netprogs/net-tools.xml@ 5531b4a

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 5531b4a was 5531b4a, checked in by Ken Moffat <ken@…>, 17 months ago

net-tools - apply the patch first.

Without this, the changes to the Makefile to comment out progs
reject. Fixes @0ea195f41b6e4020a0897a80d4ec25f859a14774

  • Property mode set to 100644
File size: 12.8 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 "&sources-anduin-http;/net-tools/net-tools-&net-tools-version;.tar.gz">
8 <!ENTITY net-tools-download-ftp "&sources-anduin-ftp;/net-tools/net-tools-&net-tools-version;.tar.gz">
9 <!ENTITY net-tools-md5sum "6be14ed473cacdd68edeaa9605adc469">
10 <!ENTITY net-tools-size "288 KB">
11 <!ENTITY net-tools-buildsize "7.0 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 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Net-tools-&net-tools-version;</title>
23
24 <indexterm zone="net-tools">
25 <primary sortas="a-Net-tools">Net-tools</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Net-tools</title>
30
31 <para>
32 The <application>Net-tools</application> package is a collection
33 of programs for controlling the network subsystem of the Linux kernel.
34 </para>
35
36 &lfs101_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&net-tools-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&net-tools-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &net-tools-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &net-tools-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &net-tools-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &net-tools-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
73 <itemizedlist spacing="compact">
74 <listitem>
75 <para>
76 Required patch:
77 <ulink url="&patch-root;/net-tools-&net-tools-version;-remove_dups-1.patch"/>
78 </para>
79 </listitem>
80 </itemizedlist>
81
82
83 <para condition="html" role="usernotes">User Notes:
84 <ulink url="&blfs-wiki;/net-tools"/></para>
85
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of Net-tools</title>
90
91 <para id="net-tools-automate-example" xreflabel="Net-tools">
92 The instructions below automate the configuration process by piping
93 <command>yes</command> to the <command>make config</command> command.
94 If you wish to run the interactive configuration process (by changing
95 the instruction to just <command>make config</command>), but you are
96 not sure how to answer all the questions, then just accept the defaults.
97 This will be just fine in the majority of cases. What you're asked here
98 is a bunch of questions about which network protocols you've enabled
99 in your kernel. The default answers will enable the tools from this
100 package to work with the most common protocols: TCP, PPP, and several
101 others. You still need to actually enable these protocols in the
102 kernel&mdash;what you do here is merely tell the package to include
103 support for those protocols in its programs, but it's up to the kernel
104 to make the protocols available.
105 </para>
106
107 <note>
108 <para>
109 This package has several unneeded protocols and hardware device
110 specific functions that are obsolete. To only build the minimum needed
111 for your system, skip the <command>yes</command> command and answer
112 each question interactively. The minimum needed options are 'UNIX
113 protocol family' and 'INET (TCP/IP) protocol family'.
114 </para>
115 </note>
116
117 <para>
118 The patch below cleans up the installation so that it does not
119 overwrite the <application>ifconfig</application> and
120 <application>hostname</application> programs that were installed in LFS.
121 </para>
122
123 <para>
124 Install <application>Net-tools</application> by running the
125 following commands:
126 </para>
127
128<screen><userinput>patch -Np1 -i ../net-tools-&net-tools-version;-remove_dups-1.patch &amp;&amp;
129sed -e "s;/\(s\|\)bin;/usr&amp;;g" -i Makefile &amp;&amp;
130sed -i '/#include &lt;netinet\/ip.h&gt;/d' iptunnel.c &amp;&amp;
131
132yes "" | make config &amp;&amp;
133make</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>make update</userinput></screen>
144
145 </sect2>
146
147 <sect2 role="commands">
148 <title>Command Explanations</title>
149
150 <para>
151 <command>sed -i "s;/\(s\|\)bin;/usr&amp;;g" -i Makefile</command>:
152 Modifies the <filename>Makefile</filename> to get the binaries
153 installed in the <filename class="directory">/usr</filename> hierarchy.
154 </para>
155
156 <para>
157 <command>sed -i '/#include &lt;netinet\/ip.h&gt;/d' iptunnel.c</command>:
158 This fixes build breakage with linux-4.8 headers.
159 </para>
160<!--
161 <para>
162 <command>sed -i -e '/Token/s/y$/n/' config.in</command>: Change the
163 default for building obsolete token ring support to no. This is a
164 simpler change than changing the location for the token ring headers.
165 </para>
166
167 <para>
168 <command>sed -i -e '/HAVE_HWSTRIP/s/y$/n/' config.in</command>:
169 Removes obsolete Metricom radio support that requires a header no longer
170 included in the kernel.
171 </para>
172-->
173 <para>
174 <command>yes "" | make config</command>: Piping <command>yes</command>
175 to <command>make config</command> skips the interactive configuration and
176 accepts the defaults.
177 </para>
178
179 </sect2>
180
181 <sect2 role="content">
182 <title>Contents</title>
183
184 <segmentedlist>
185 <segtitle>Installed Programs</segtitle>
186 <segtitle>Installed Libraries</segtitle>
187 <segtitle>Installed Directories</segtitle>
188
189 <seglistitem>
190 <seg>arp,
191 ipmaddr, iptunnel, mii-tool, nameif, netstat,
192 plipconfig, rarp, route, and slattach
193 </seg>
194 <seg>None</seg>
195 <seg>None</seg>
196 </seglistitem>
197 </segmentedlist>
198
199 <variablelist>
200 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
201 <?dbfo list-presentation="list"?>
202 <?dbhtml list-presentation="table"?>
203
204 <varlistentry id="arp">
205 <term><command>arp</command></term>
206 <listitem>
207 <para>
208 is used to manipulate the kernel's ARP cache, usually
209 to add or delete an entry, or to dump the entire cache
210 </para>
211 <indexterm zone="net-tools arp">
212 <primary sortas="b-arp">arp</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216<!--
217 <varlistentry id="dnsdomainname">
218 <term><command>dnsdomainname</command></term>
219 <listitem>
220 <para>
221 reports the system's DNS domain name.
222 </para>
223 <indexterm zone="net-tools dnsdomainname">
224 <primary sortas="b-dnsdomainname">dnsdomainname</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="domainname">
230 <term><command>domainname</command></term>
231 <listitem>
232 <para>
233 reports or sets the system's NIS/YP domain name.
234 </para>
235 <indexterm zone="net-tools domainname">
236 <primary sortas="b-domainname">domainname</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="hostname">
242 <term><command>hostname</command></term>
243 <listitem>
244 <para>
245 reports or sets the name of the current host system.
246 </para>
247 <indexterm zone="net-tools hostname">
248 <primary sortas="b-hostname">hostname</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="ifconfig">
254 <term><command>ifconfig</command></term>
255 <listitem>
256 <para>
257 is the main utility for configuring network interfaces.
258 </para>
259 <indexterm zone="net-tools ifconfig">
260 <primary sortas="b-ifconfig">ifconfig</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264-->
265 <varlistentry id="ipmaddr">
266 <term><command>ipmaddr</command></term>
267 <listitem>
268 <para>
269 adds, deletes and shows an interface's multicast addresses
270 </para>
271 <indexterm zone="net-tools ipmaddr">
272 <primary sortas="b-ipmaddr">ipmaddr</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="iptunnel">
278 <term><command>iptunnel</command></term>
279 <listitem>
280 <para>
281 adds, changes, deletes and shows an interface's tunnels
282 </para>
283 <indexterm zone="net-tools iptunnel">
284 <primary sortas="b-iptunnel">iptunnel</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="mii-tool">
290 <term><command>mii-tool</command></term>
291 <listitem>
292 <para>
293 checks or sets the status of a network interface's Media
294 Independent Interface (MII) unit
295 </para>
296 <indexterm zone="net-tools mii-tool">
297 <primary sortas="b-mii-tool">mii-tool</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="nameif">
303 <term><command>nameif</command></term>
304 <listitem>
305 <para>
306 names network interfaces based on MAC addresses
307 </para>
308 <indexterm zone="net-tools nameif">
309 <primary sortas="b-nameif">nameif</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="netstat">
315 <term><command>netstat</command></term>
316 <listitem>
317 <para>
318 is used to report network connections, routing tables, and
319 interface statistics
320 </para>
321 <indexterm zone="net-tools netstat">
322 <primary sortas="b-netstat">netstat</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326<!--
327 <varlistentry id="nisdomainname">
328 <term><command>nisdomainname</command></term>
329 <listitem>
330 <para>
331 does the same as <command>domainname</command>.
332 </para>
333 <indexterm zone="net-tools nisdomainname">
334 <primary sortas="b-nisdomainname">nisdomainname</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338-->
339 <varlistentry id="plipconfig">
340 <term><command>plipconfig</command></term>
341 <listitem>
342 <para>
343 is used to fine tune the PLIP device parameters, to
344 improve its performance
345 </para>
346 <indexterm zone="net-tools plipconfig">
347 <primary sortas="b-plipconfig">plipconfig</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="rarp">
353 <term><command>rarp</command></term>
354 <listitem>
355 <para>
356 is used to manipulate the kernel's RARP table
357 </para>
358 <indexterm zone="net-tools rarp">
359 <primary sortas="b-rarp">rarp</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="route">
365 <term><command>route</command></term>
366 <listitem>
367 <para>
368 is used to manipulate the IP routing table
369 </para>
370 <indexterm zone="net-tools route">
371 <primary sortas="b-route">route</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="slattach">
377 <term><command>slattach</command></term>
378 <listitem>
379 <para>
380 attaches a network interface to a serial line. This allows you to
381 use normal terminal lines for point-to-point links to others
382 computers
383 </para>
384 <indexterm zone="net-tools slattach">
385 <primary sortas="b-slattach">slattach</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389<!--
390 <varlistentry id="ypdomainname">
391 <term><command>ypdomainname</command></term>
392 <listitem>
393 <para>
394 does the same as <command>domainname</command>.
395 </para>
396 <indexterm zone="net-tools ypdomainname">
397 <primary sortas="b-ypdomainname">ypdomainname</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401-->
402 </variablelist>
403
404 </sect2>
405
406</sect1>
Note: See TracBrowser for help on using the repository browser.