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

systemd
Last change on this file since 12dce87 was 12dce87, checked in by William Harrington <kb0iic@…>, 7 years ago

Update to IProute2 4.9.0 and removal of libdir patch.

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