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

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since cc3e112 was 56fbc70, checked in by William Harrington <kb0iic@…>, 11 years ago

Fix misspelling.

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