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

sysvinit
Last change on this file since 6e2f5b2 was 6e2f5b2, checked in by William Harrington <kb0iic@…>, 5 years ago

Fix format.

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