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

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

Remove extraneous arpd dir and manpage

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