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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 10a8dea was 10a8dea, checked in by Chris Staub <chris@…>, 14 years ago

SBINDIR parameter no longer needed for iproute2, because of DESTDIR

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