source: chapter08/iproute2.xml@ f081763

ml-11.0 multilib
Last change on this file since f081763 was f081763, checked in by Thomas Trepl (Moody) <thomas@…>, 13 months ago

Tweak install in iproute2 (rmv DOCDIR)

  • Property mode set to 100644
File size: 11.5 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
8<sect1 id="ch-system-iproute2" role="wrap">
9 <?dbhtml filename="iproute2.html"?>
10
11 <sect1info condition="script">
12 <productname>iproute2</productname>
13 <productnumber>&iproute2-version;</productnumber>
14 <address>&iproute2-url;</address>
15 </sect1info>
16
17 <title>IPRoute2-&iproute2-version;</title>
18
19 <indexterm zone="ch-system-iproute2">
20 <primary sortas="a-IPRoute2">IPRoute2</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The IPRoute2 package contains programs for basic and advanced IPV4-based
27 networking.</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&iproute2-fin-sbu;</seg>
35 <seg>&iproute2-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of IPRoute2</title>
43
44 <para>The <command>arpd</command> program included in this package will not
45 be built since it is dependent on Berkeley DB, which is not installed in
46 LFS. However, a directory for <command>arpd</command> and a man page will still
47 be installed. Prevent this by running the commands below.
48 If the <command>arpd</command> binary is needed,
49 instructions for compiling Berkeley DB can be found in the BLFS Book at
50 <ulink url="&blfs-book;server/db.html"/>.
51 </para>
52
53<screen><userinput remap="pre">sed -i /ARPD/d Makefile
54rm -fv man/man8/arpd.8</userinput></screen>
55
56 <para>It is also necessary to disable building two modules that
57 require <ulink url="&blfs-book;postlfs/iptables.html"/>.</para>
58
59<screen><userinput remap="pre">sed -i 's/.m_ipt.o//' tc/Makefile</userinput></screen>
60
61 <para>Compile the package:</para>
62
63<screen><userinput remap="make">make</userinput></screen>
64
65 <para>This package does not have a working test suite.</para>
66<!-- currently not useful, no tests actually run
67 <para>This package comes with a test suite, but due to assumptions it makes,
68 it is not possible to reliably run these tests from within the chroot
69 environment. If you wish to run these tests after booting into your new LFS
70 system, ensure you enable <filename>/proc/config.gz</filename> support
71 in your kernel (&quot;General setup&quot; -> &quot;Enable access to
72 .config through /proc/config.gz&quot; [CONFIG_IKCONFIG_PROC]), then run
73 'make alltests' from the <filename class="directory">testsuite/</filename>
74 subdirectory.</para>-->
75
76 <para>Install the package:</para>
77
78<screen><userinput remap="install">make install</userinput></screen>
79
80 <para>If desired, install the documentation:</para>
81
82<screen><userinput remap="install">mkdir -v /usr/share/doc/iproute2-&iproute2-version;
83cp -v COPYING README* /usr/share/doc/iproute2-&iproute2-version;</userinput></screen>
84
85 </sect2>
86
87 <sect2 id="contents-iproute2" role="content">
88 <title>Contents of IPRoute2</title>
89
90 <segmentedlist>
91 <segtitle>Installed programs</segtitle>
92 <segtitle>Installed directories</segtitle>
93
94 <seglistitem>
95 <seg>bridge, ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
96 nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
97 and tc</seg>
98 <seg>/etc/iproute2, /usr/lib/tc, and /usr/share/doc/iproute2-&iproute2-version;
99 </seg>
100 </seglistitem>
101 </segmentedlist>
102
103 <variablelist>
104 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
105 <?dbfo list-presentation="list"?>
106 <?dbhtml list-presentation="table"?>
107
108 <varlistentry id="bridge">
109 <term><command>bridge</command></term>
110 <listitem>
111 <para>Configures network bridges</para>
112 <indexterm zone="ch-system-iproute2 bridge">
113 <primary sortas="b-bridge">bridge</primary>
114 </indexterm>
115 </listitem>
116 </varlistentry>
117
118 <varlistentry id="ctstat">
119 <term><command>ctstat</command></term>
120 <listitem>
121 <para>Connection status utility</para>
122 <indexterm zone="ch-system-iproute2 ctstat">
123 <primary sortas="b-ctstat">ctstat</primary>
124 </indexterm>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry id="genl">
129 <term><command>genl</command></term>
130 <listitem>
131 <para>Generic netlink utility frontend</para>
132 <indexterm zone="ch-system-iproute2 genl">
133 <primary sortas="b-genl">genl</primary>
134 </indexterm>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry id="ifcfg">
139 <term><command>ifcfg</command></term>
140 <listitem>
141 <para>A shell script wrapper for the <command>ip</command> command
142 [Note that it requires the <command>arping</command> and
143 <command>rdisk</command> programs from the
144 iputils package found at <ulink url="http://www.skbuff.net/iputils/"/>.]</para>
145 <indexterm zone="ch-system-iproute2 ifcfg">
146 <primary sortas="b-ifcfg">ifcfg</primary>
147 </indexterm>
148 </listitem>
149 </varlistentry>
150
151 <varlistentry id="ifstat">
152 <term><command>ifstat</command></term>
153 <listitem>
154 <para>Shows the interface statistics, including the amount of
155 transmitted and received packets by interface</para>
156 <indexterm zone="ch-system-iproute2 ifstat">
157 <primary sortas="b-ifstat">ifstat</primary>
158 </indexterm>
159 </listitem>
160 </varlistentry>
161
162 <varlistentry id="ip">
163 <term><command>ip</command></term>
164 <listitem>
165 <para>The main executable. It has several different functions:</para>
166
167 <para><command>ip link <replaceable>&lt;device&gt;</replaceable></command>
168 allows users to look at the state of devices and to make changes</para>
169
170 <para><command>ip addr</command> allows users to look at addresses and
171 their properties, add new addresses, and delete old ones</para>
172
173 <para><command>ip neighbor</command> allows users to look at neighbor
174 bindings and their properties, add new neighbor entries, and delete
175 old ones</para>
176
177 <para><command>ip rule</command> allows users to look at the routing
178 policies and change them</para>
179
180 <para><command>ip route</command> allows users to look at the routing
181 table and change routing table rules</para>
182
183 <para><command>ip tunnel</command> allows users to look at the IP
184 tunnels and their properties, and change them</para>
185
186 <para><command>ip maddr</command> allows users to look at the multicast
187 addresses and their properties, and change them</para>
188
189 <para><command>ip mroute</command> allows users to set, change, or
190 delete the multicast routing</para>
191
192 <para><command>ip monitor</command> allows users to continuously monitor
193 the state of devices, addresses and routes</para>
194 <indexterm zone="ch-system-iproute2 ip">
195 <primary sortas="b-ip">ip</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="lnstat">
201 <term><command>lnstat</command></term>
202 <listitem>
203 <para>Provides Linux network statistics; it is a generalized and more
204 feature-complete replacement for the old <command>rtstat</command>
205 program</para>
206 <indexterm zone="ch-system-iproute2 lnstat">
207 <primary sortas="b-lnstat">lnstat</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="nstat">
213 <term><command>nstat</command></term>
214 <listitem>
215 <para>Shows network statistics</para>
216 <indexterm zone="ch-system-iproute2 nstat">
217 <primary sortas="b-nstat">nstat</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="routef">
223 <term><command>routef</command></term>
224 <listitem>
225 <para>A component of <command>ip route</command>. This is for flushing
226 the routing tables</para>
227 <indexterm zone="ch-system-iproute2 routef">
228 <primary sortas="b-routef">routef</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="routel">
234 <term><command>routel</command></term>
235 <listitem>
236 <para>A component of <command>ip route</command>. This is for listing
237 the routing tables</para>
238 <indexterm zone="ch-system-iproute2 routel">
239 <primary sortas="b-routel">routel</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="rtacct">
245 <term><command>rtacct</command></term>
246 <listitem>
247 <para>Displays the contents of
248 <filename>/proc/net/rt_acct</filename></para>
249 <indexterm zone="ch-system-iproute2 rtacct">
250 <primary sortas="b-rtacct">rtacct</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="rtmon">
256 <term><command>rtmon</command></term>
257 <listitem>
258 <para>Route monitoring utility</para>
259 <indexterm zone="ch-system-iproute2 rtmon">
260 <primary sortas="b-rtmon">rtmon</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="rtpr">
266 <term><command>rtpr</command></term>
267 <listitem>
268 <para>Converts the output of <command>ip -o</command> back into a
269 readable form</para>
270 <indexterm zone="ch-system-iproute2 rtpr">
271 <primary sortas="b-rtpr">rtpr</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="rtstat">
277 <term><command>rtstat</command></term>
278 <listitem>
279 <para>Route status utility</para>
280 <indexterm zone="ch-system-iproute2 rtstat">
281 <primary sortas="b-rtstat">rtstat</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="ss">
287 <term><command>ss</command></term>
288 <listitem>
289 <para>Similar to the <command>netstat</command> command; shows active
290 connections</para>
291 <indexterm zone="ch-system-iproute2 ss">
292 <primary sortas="b-ss">ss</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="tc">
298 <term><command>tc</command></term>
299 <listitem>
300 <para>Traffic Controlling Executable; this is for Quality Of Service
301 (QOS) and Class Of Service (COS) implementations</para>
302
303 <para><command>tc qdisc</command> allows users to setup the queueing
304 discipline</para>
305
306 <para><command>tc class</command> allows users to setup classes based
307 on the queuing discipline scheduling</para>
308
309 <para><command>tc estimator</command> allows users to estimate the
310 network flow into a network</para>
311
312 <para><command>tc filter</command> allows users to setup the QOS/COS
313 packet filtering</para>
314
315 <para><command>tc policy</command> allows users to setup the QOS/COS
316 policies</para>
317 <indexterm zone="ch-system-iproute2 ss">
318 <primary sortas="b-tc">tc</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 </variablelist>
324
325 </sect2>
326
327</sect1>
Note: See TracBrowser for help on using the repository browser.