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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 213aa8a9 was 16dcec0, checked in by Chris Staub <chris@…>, 17 years ago

Grammar fix in iproute2 instructions

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