source: chapter06/iproute2.xml@ f78c4af

6.1 6.1.1
Last change on this file since f78c4af was f78c4af, checked in by Manuel Canales Esparcia <manuel@…>, 19 years ago

Ported r4590 from trunk: Fixed some typos in indexterm tags.

git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/6.1/BOOK@4951 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 10.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3 <!ENTITY % general-entities SYSTEM "../general.ent">
4 %general-entities;
5]>
6<sect1 id="ch-system-iproute2" role="wrap">
7 <title>IPRoute2-&iproute2-version;</title>
8<?dbhtml filename="iproute2.html"?>
9 <indexterm zone="ch-system-iproute2">
10 <primary sortas="a-IPRoute2">IPRoute2</primary>
11 </indexterm>
12 <sect2 role="package">
13 <title/>
14 <para>The IPRoute2 package contains programs for basic and advanced
15 IPV4-based networking.
16 </para>
17 <segmentedlist>
18 <segtitle>&buildtime;</segtitle>
19 <segtitle>&diskspace;</segtitle>
20 <seglistitem>
21 <seg>0.1 SBU</seg>
22 <seg>3.4 MB</seg>
23 </seglistitem>
24 </segmentedlist>
25 <segmentedlist>
26 <segtitle>&dependencies;</segtitle>
27 <seglistitem>
28 <seg>GCC, Glibc, Make, Linux-Headers, and Sed</seg>
29 </seglistitem>
30 </segmentedlist>
31 </sect2>
32 <sect2 role="installation">
33 <title>Installation of IPRoute2</title>
34 <para>The <command>arpd</command> binary included in this package is
35 dependent on Berkeley DB. Because <command>arpd</command> is not a very
36 common requirement on a base Linux system, remove the dependency on
37 Berkeley DB by applying the patch using the command below. If
38 the <command>arpd</command> binary is needed, instructions for
39 compiling Berkeley DB can be found in the BLFS Book at <ulink
40 url="&blfs-root;view/svn/content/databases.html#db"/>.
41 </para>
42
43 <screen><userinput>patch -Np1 -i ../iproute2-&iproute2-patch-version;-remove_db-1.patch</userinput></screen>
44
45 <para>Prepare IPRoute2 for compilation:</para>
46 <screen><userinput>./configure </userinput></screen>
47
48 <para>Compile the package:</para>
49
50 <screen><userinput>make SBINDIR=/sbin</userinput></screen>
51
52 <para>The meaning of the make option:</para>
53
54 <variablelist>
55 <varlistentry>
56 <term><parameter>SBINDIR=/sbin</parameter></term>
57 <listitem><para>This makes sure that the IPRoute2 binaries will install into
58 <filename class="directory">/sbin</filename>. This is the correct
59 location according to the FHS, because some of the IPRoute2 binaries are used
60 in the bootscripts.</para>
61 </listitem>
62 </varlistentry>
63 </variablelist>
64
65 <para>Install the package:</para>
66
67 <screen><userinput>make SBINDIR=/sbin install</userinput></screen>
68 </sect2>
69
70 <sect2 id="contents-iproute2" role="content">
71 <title>Contents of IPRoute2</title>
72 <segmentedlist>
73 <segtitle>Installed programs</segtitle>
74 <seglistitem>
75 <seg>ctstat (link to lnstat), ifcfg, ifstat, ip, lnstat, nstat, routef,
76 routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss, and tc.
77 </seg>
78 </seglistitem>
79 </segmentedlist>
80
81 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
82<?dbfo list-presentation="list"?>
83<?dbhtml list-presentation="table"?>
84 <varlistentry id="ctstat">
85 <term>
86 <command>ctstat</command>
87 </term>
88 <listitem>
89 <para>Connection status utility</para>
90 <indexterm zone="ch-system-iproute2 ctstat">
91 <primary sortas="b-ctstat">ctstat</primary>
92 </indexterm>
93 </listitem>
94 </varlistentry>
95
96 <varlistentry id="ifcfg">
97 <term>
98 <command>ifcfg</command>
99 </term>
100 <listitem>
101 <para>A shell script wrapper for the <command>ip</command> command</para>
102 <indexterm zone="ch-system-iproute2 ifcfg">
103 <primary sortas="b-ifcfg">ifcfg</primary>
104 </indexterm>
105 </listitem>
106 </varlistentry>
107
108 <varlistentry id="ifstat">
109 <term>
110 <command>ifstat</command>
111 </term>
112 <listitem>
113 <para>Shows the interfaces statistic, including the amount of transmitted
114 and received packages by interface</para>
115 <indexterm zone="ch-system-iproute2 ifstat">
116 <primary sortas="b-ifstat">ifstat</primary>
117 </indexterm>
118 <beginpage/>
119 </listitem>
120 </varlistentry>
121
122 <varlistentry id="ip">
123 <term>
124 <command>ip</command>
125 </term>
126 <listitem>
127
128 <para>The main executable. It has several different functions:</para>
129
130 <para><command>ip link <replaceable>[device]</replaceable></command>
131 allows users to look at the state of devices and to make changes
132 </para>
133
134 <para><command>ip addr</command> allows users to look at addresses and
135 their properties, add new addresses, and delete old ones
136 </para>
137
138 <para><command>ip neighbor</command> allows users to look at
139 neighbor bindings and their properties, add new
140 neighbor entries, and delete old ones
141 </para>
142
143 <para><command>ip rule</command> allows users to look at the routing
144 policies and change them
145 </para>
146
147 <para><command>ip route</command> allows users to look at the routing
148 table and change routing table rules
149 </para>
150
151 <para><command>ip tunnel</command> allows users to look at the IP
152 tunnels and their properties, and change them
153 </para>
154
155 <para><command>ip maddr</command> allows users to look at the multicast
156 addresses and their properties, and change them
157 </para>
158
159 <para><command>ip mroute</command> allows users to set, change, or
160 delete the multicast routing
161 </para>
162
163 <para><command>ip monitor</command> allows users to
164 continously monitor the state of devices, addresses and routes
165 </para>
166 <indexterm zone="ch-system-iproute2 ip">
167 <primary sortas="b-ip">ip</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 <varlistentry id="lnstat">
173 <term>
174 <command>lnstat</command>
175 </term>
176 <listitem>
177 <para>Provides Linux network statistics. It is a generalized and more
178 feature-complete replacement for the old
179 <command>rtstat</command> program</para>
180 <indexterm zone="ch-system-iproute2 lnstat">
181 <primary sortas="b-cstat">lnstat</primary>
182 </indexterm>
183 </listitem>
184 </varlistentry>
185
186 <varlistentry id="nstat">
187 <term>
188 <command>nstat</command>
189 </term>
190 <listitem>
191 <para>Shows network statistics</para>
192 <indexterm zone="ch-system-iproute2 nstat">
193 <primary sortas="b-nstat">nstat</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="routef">
199 <term>
200 <command>routef</command>
201 </term>
202 <listitem>
203 <para>A component of <command>ip route</command>. This is for flushing the routing
204 tables
205 </para>
206 <indexterm zone="ch-system-iproute2 routef">
207 <primary sortas="b-routef">routef</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="routel">
213 <term>
214 <command>routel</command>
215 </term>
216 <listitem>
217 <para>A component of <command>ip route</command>. This is for listing the routing
218 tables
219 </para>
220 <indexterm zone="ch-system-iproute2 routel">
221 <primary sortas="b-routel">routel</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="rtacct">
227 <term>
228 <command>rtacct</command>
229 </term>
230 <listitem>
231 <para>Displays the contents of <filename>/proc/net/rt_acct</filename></para>
232 <indexterm zone="ch-system-iproute2 rtacct">
233 <primary sortas="b-rtacct">rtacct</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="rtmon">
239 <term>
240 <command>rtmon</command>
241 </term>
242 <listitem>
243 <para>Route monitoring utility</para>
244 <indexterm zone="ch-system-iproute2 rtmon">
245 <primary sortas="b-rtmon">rtmon</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="rtpr">
251 <term>
252 <command>rtpr</command>
253 </term>
254 <listitem>
255 <para>Converts the output of <command>ip -o</command> back into a
256 readable form</para>
257 <indexterm zone="ch-system-iproute2 rtpr">
258 <primary sortas="b-rtpr">rtpr</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="rtstat">
264 <term>
265 <command>rtstat</command>
266 </term>
267 <listitem>
268 <para>Route status utility</para>
269 <indexterm zone="ch-system-iproute2 rtstat">
270 <primary sortas="b-rtstat">rtstat</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="ss">
276 <term>
277 <command>ss</command>
278 </term>
279 <listitem>
280 <para>Similar to the <command>netstat</command> command; shows active connections</para>
281 <indexterm zone="ch-system-iproute2 ss">
282 <primary sortas="b-ss">ss</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="tc">
288 <term>
289 <command>tc</command>
290 </term>
291 <listitem>
292 <para>Traffic Controlling Executable; this is for Quality Of
293Service (QOS) and Class Of Service (COS)
294 implementations
295 </para>
296
297 <para><command>tc qdisc</command> allows users to setup the queueing
298 discipline
299 </para>
300
301 <para><command>tc class</command> allows users to setup classes based on
302 the queuing discipline scheduling
303 </para>
304
305 <para><command>tc estimator</command> allows users to estimate the
306 network flow into a network
307 </para>
308
309 <para><command>tc filter</command> allows users to setup the QOS/COS
310 packet filtering
311 </para>
312
313 <para><command>tc policy</command> allows users to setup the QOS/COS
314 policies
315 </para>
316 <indexterm zone="ch-system-iproute2 ss">
317 <primary sortas="b-tc">tc</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321 </variablelist>
322 </sect2>
323</sect1>
324
Note: See TracBrowser for help on using the repository browser.