source: BOOK/final-system/common/iproute2.xml@ dc2c506

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since dc2c506 was 61ad0b7f, checked in by Chris Staub <chris@…>, 15 years ago

Added installed directory info for a number of packages

  • Property mode set to 100644
File size: 10.6 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 <title>IPRoute2-&iproute2-version;</title>
12
13 <indexterm zone="ch-system-iproute2">
14 <primary sortas="a-IPRoute2">IPRoute2</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The IPRoute2 package contains programs for basic and advanced
21 IPV4-based networking.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of IPRoute2</title>
27
28 <para os="s1">By default, this package builds the <command>arpd</command>
29 program, which is dependent on Berkeley DB. Because <command>arpd</command>
30 is not a very common requirement on a base Linux system, remove the
31 dependency on Berkeley DB by applying the <command>sed</command> command
32 below. If the <command>arpd</command> binary is needed, instructions for
33 compiling Berkeley DB can be found in CBLFS at <ulink
34 url="&cblfs-root;index.php/Berkeley_DB"/>.</para>
35
36<screen os="s2"><userinput>sed -i '/^TARGETS/s@arpd@@g' misc/Makefile</userinput></screen>
37
38 <para os="a">Compile the package:</para>
39
40<screen os="b"><userinput>make DESTDIR= DOCDIR=/usr/share/doc/iproute2 \
41 MANDIR=/usr/share/man</userinput></screen>
42
43 <variablelist os="c">
44 <title>The meaning of the make option:</title>
45
46 <varlistentry>
47 <term><parameter>DESTDIR=</parameter></term>
48 <listitem>
49 <para>This option overrides the default DESTDIR of /usr, so that
50 that the IPRoute2 binaries will be installed into
51 <filename class="directory">/sbin</filename>. This is the correct
52 location according to the FHS, because some of the IPRoute2 binaries
53 are used by the CLFS-Bootscripts package.</para>
54 </listitem>
55 </varlistentry>
56
57 <varlistentry>
58 <term><parameter>DOCDIR=/usr/share/doc/iproute2 MANDIR=/usr/share/man</parameter></term>
59 <listitem>
60 <para>The DESTDIR=/ parameter would cause documentation to be
61 installed into <filename class="directory">/share/doc</filename> and
62 <filename class="directory">/share/man</filename>. These options
63 ensure the docs are installed to the correct locations.</para>
64 </listitem>
65 </varlistentry>
66 </variablelist>
67
68 <para os="d">This package does not come with a test suite.</para>
69
70 <para os="e">Install the package:</para>
71
72<screen os="f"><userinput>make DESTDIR= DOCDIR=/usr/share/doc/iproute2 \
73 MANDIR=/usr/share/man install</userinput></screen>
74
75 </sect2>
76
77 <sect2 id="contents-iproute2" role="content">
78 <title>Contents of IPRoute2</title>
79
80 <segmentedlist>
81 <segtitle>Installed programs</segtitle>
82 <segtitle>Installed directories</segtitle>
83
84 <seglistitem>
85 <seg>ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat, nstat,
86 routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
87 and tc</seg>
88 <seg>/etc/iproute2, /lib/tc, /usr/lib/tc, /usr/share/doc/iproute2</seg>
89 </seglistitem>
90 </segmentedlist>
91
92 <variablelist>
93 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
94 <?dbfo list-presentation="list"?>
95 <?dbhtml list-presentation="table"?>
96
97 <varlistentry id="ctstat">
98 <term><command>ctstat</command></term>
99 <listitem>
100 <para>Connection status utility</para>
101 <indexterm zone="ch-system-iproute2 ctstat">
102 <primary sortas="b-ctstat">ctstat</primary>
103 </indexterm>
104 </listitem>
105 </varlistentry>
106
107 <varlistentry id="genl">
108 <term><command>genl</command></term>
109 <listitem>
110 <para>Needs description</para>
111 <indexterm zone="ch-system-iproute2 genl">
112 <primary sortas="b-genl">genl</primary>
113 </indexterm>
114 </listitem>
115 </varlistentry>
116
117 <varlistentry id="ifcfg">
118 <term><command>ifcfg</command></term>
119 <listitem>
120 <para>A shell script wrapper for the <command>ip</command>
121 command</para>
122 <indexterm zone="ch-system-iproute2 ifcfg">
123 <primary sortas="b-ifcfg">ifcfg</primary>
124 </indexterm>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry id="ifstat">
129 <term><command>ifstat</command></term>
130 <listitem>
131 <para>Shows the interface statistics, including the amount of
132 transmitted and received packets by interface</para>
133 <indexterm zone="ch-system-iproute2 ifstat">
134 <primary sortas="b-ifstat">ifstat</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138
139 <varlistentry id="ip">
140 <term><command>ip</command></term>
141 <listitem>
142 <para>The main executable. It has several different functions:</para>
143
144 <para><command>ip link <replaceable>[device]</replaceable></command>
145 allows users to look at the state of devices and to make changes</para>
146
147 <para><command>ip addr</command> allows users to look at addresses and
148 their properties, add new addresses, and delete old ones</para>
149
150 <para><command>ip neighbor</command> allows users to look at neighbor
151 bindings and their properties, add new neighbor entries, and delete
152 old ones</para>
153
154 <para><command>ip rule</command> allows users to look at the routing
155 policies and change them</para>
156
157 <para><command>ip route</command> allows users to look at the routing
158 table and change routing table rules</para>
159
160 <para><command>ip tunnel</command> allows users to look at the IP
161 tunnels and their properties, and change them</para>
162
163 <para><command>ip maddr</command> allows users to look at the multicast
164 addresses and their properties, and change them</para>
165
166 <para><command>ip mroute</command> allows users to set, change, or
167 delete the multicast routing</para>
168
169 <para><command>ip monitor</command> allows users to continously monitor
170 the state of devices, addresses and routes</para>
171 <indexterm zone="ch-system-iproute2 ip">
172 <primary sortas="b-ip">ip</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry>
176
177 <varlistentry id="lnstat">
178 <term><command>lnstat</command></term>
179 <listitem>
180 <para>Provides Linux network statistics. It is a generalized and more
181 feature-complete replacement for the old <command>rtstat</command>
182 program</para>
183 <indexterm zone="ch-system-iproute2 lnstat">
184 <primary sortas="b-lnstat">lnstat</primary>
185 </indexterm>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry id="nstat">
190 <term><command>nstat</command></term>
191 <listitem>
192 <para>Shows network statistics</para>
193 <indexterm zone="ch-system-iproute2 nstat">
194 <primary sortas="b-nstat">nstat</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="routef">
200 <term><command>routef</command></term>
201 <listitem>
202 <para>A component of <command>ip route</command>. This is for flushing
203 the routing tables</para>
204 <indexterm zone="ch-system-iproute2 routef">
205 <primary sortas="b-routef">routef</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="routel">
211 <term><command>routel</command></term>
212 <listitem>
213 <para>A component of <command>ip route</command>. This is for listing
214 the routing tables</para>
215 <indexterm zone="ch-system-iproute2 routel">
216 <primary sortas="b-routel">routel</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="rtacct">
222 <term><command>rtacct</command></term>
223 <listitem>
224 <para>Displays the contents of
225 <filename>/proc/net/rt_acct</filename></para>
226 <indexterm zone="ch-system-iproute2 rtacct">
227 <primary sortas="b-rtacct">rtacct</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="rtmon">
233 <term><command>rtmon</command></term>
234 <listitem>
235 <para>Route monitoring utility</para>
236 <indexterm zone="ch-system-iproute2 rtmon">
237 <primary sortas="b-rtmon">rtmon</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="rtpr">
243 <term><command>rtpr</command></term>
244 <listitem>
245 <para>Converts the output of <command>ip -o</command> back into a
246 readable form</para>
247 <indexterm zone="ch-system-iproute2 rtpr">
248 <primary sortas="b-rtpr">rtpr</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="rtstat">
254 <term><command>rtstat</command></term>
255 <listitem>
256 <para>Route status utility</para>
257 <indexterm zone="ch-system-iproute2 rtstat">
258 <primary sortas="b-rtstat">rtstat</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="ss">
264 <term><command>ss</command></term>
265 <listitem>
266 <para>Similar to the <command>netstat</command> command; shows
267 active connections</para>
268 <indexterm zone="ch-system-iproute2 ss">
269 <primary sortas="b-ss">ss</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="tc">
275 <term><command>tc</command></term>
276 <listitem>
277 <para>Traffic Controlling Executable; this is for Quality Of Service
278 (QOS) and Class Of Service (COS) implementations</para>
279
280 <para><command>tc qdisc</command> allows users to setup the queueing
281 discipline</para>
282
283 <para><command>tc class</command> allows users to setup classes based on
284 the queuing discipline scheduling</para>
285
286 <para><command>tc estimator</command> allows users to estimate the
287 network flow into a network</para>
288
289 <para><command>tc filter</command> allows users to setup the QOS/COS
290 packet filtering</para>
291
292 <para><command>tc policy</command> allows users to setup the QOS/COS
293 policies</para>
294 <indexterm zone="ch-system-iproute2 ss">
295 <primary sortas="b-tc">tc</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 </variablelist>
301
302 </sect2>
303
304</sect1>
Note: See TracBrowser for help on using the repository browser.