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

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

Install documentation with versioned directory and add/update installed directories.

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