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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since cade792 was 0d4607d, checked in by Jim Gifford <clfs@…>, 17 years ago

Removed References to BLFS

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