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

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

Correct command explanations on IPRoute2 page

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