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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since e3a1e522 was e3a1e522, checked in by Jim Gifford <clfs@…>, 18 years ago

r981@server (orig r979): jim | 2005-12-30 10:11:32 -0800

r1226@server: cstaub | 2005-12-30 08:35:37 -0800
Updated package deps, removed explanation of cross-compiling from final-system binutils, and removed note about GRUB's testsuite failure


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