source: clfs-sysroot/BOOK/final-system/common/iproute2.xml @ 3322dab

Last change on this file since 3322dab was 3322dab, checked in by Jim Gifford <clfs@…>, 13 years ago

r3818@server (orig r1720): jciccone | 2006-06-05 14:19:47 -0700
text updates

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