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

clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since b1a073dc was b1a073dc, checked in by Chris Staub <chris@…>, 8 years ago

Text update

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