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

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

Improve consistency in package installation lists, mainly removing 'and'

Conflicts:

BOOK/final-system/common/attr.xml

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