| 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), genl, 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="genl">
|
|---|
| 105 | <term><command>genl</command></term>
|
|---|
| 106 | <listitem>
|
|---|
| 107 | <para>Needs description</para>
|
|---|
| 108 | <indexterm zone="ch-system-iproute2 genl">
|
|---|
| 109 | <primary sortas="b-genl">genl</primary>
|
|---|
| 110 | </indexterm>
|
|---|
| 111 | </listitem>
|
|---|
| 112 | </varlistentry>
|
|---|
| 113 |
|
|---|
| 114 | <varlistentry id="ifcfg">
|
|---|
| 115 | <term><command>ifcfg</command></term>
|
|---|
| 116 | <listitem>
|
|---|
| 117 | <para>A shell script wrapper for the <command>ip</command>
|
|---|
| 118 | command</para>
|
|---|
| 119 | <indexterm zone="ch-system-iproute2 ifcfg">
|
|---|
| 120 | <primary sortas="b-ifcfg">ifcfg</primary>
|
|---|
| 121 | </indexterm>
|
|---|
| 122 | </listitem>
|
|---|
| 123 | </varlistentry>
|
|---|
| 124 |
|
|---|
| 125 | <varlistentry id="ifstat">
|
|---|
| 126 | <term><command>ifstat</command></term>
|
|---|
| 127 | <listitem>
|
|---|
| 128 | <para>Shows the interface statistics, including the amount of
|
|---|
| 129 | transmitted and received packets by interface</para>
|
|---|
| 130 | <indexterm zone="ch-system-iproute2 ifstat">
|
|---|
| 131 | <primary sortas="b-ifstat">ifstat</primary>
|
|---|
| 132 | </indexterm>
|
|---|
| 133 | </listitem>
|
|---|
| 134 | </varlistentry>
|
|---|
| 135 |
|
|---|
| 136 | <varlistentry id="ip">
|
|---|
| 137 | <term><command>ip</command></term>
|
|---|
| 138 | <listitem>
|
|---|
| 139 | <para>The main executable. It has several different functions:</para>
|
|---|
| 140 |
|
|---|
| 141 | <para><command>ip link <replaceable>[device]</replaceable></command>
|
|---|
| 142 | allows users to look at the state of devices and to make changes</para>
|
|---|
| 143 |
|
|---|
| 144 | <para><command>ip addr</command> allows users to look at addresses and
|
|---|
| 145 | their properties, add new addresses, and delete old ones</para>
|
|---|
| 146 |
|
|---|
| 147 | <para><command>ip neighbor</command> allows users to look at neighbor
|
|---|
| 148 | bindings and their properties, add new neighbor entries, and delete
|
|---|
| 149 | old ones</para>
|
|---|
| 150 |
|
|---|
| 151 | <para><command>ip rule</command> allows users to look at the routing
|
|---|
| 152 | policies and change them</para>
|
|---|
| 153 |
|
|---|
| 154 | <para><command>ip route</command> allows users to look at the routing
|
|---|
| 155 | table and change routing table rules</para>
|
|---|
| 156 |
|
|---|
| 157 | <para><command>ip tunnel</command> allows users to look at the IP
|
|---|
| 158 | tunnels and their properties, and change them</para>
|
|---|
| 159 |
|
|---|
| 160 | <para><command>ip maddr</command> allows users to look at the multicast
|
|---|
| 161 | addresses and their properties, and change them</para>
|
|---|
| 162 |
|
|---|
| 163 | <para><command>ip mroute</command> allows users to set, change, or
|
|---|
| 164 | delete the multicast routing</para>
|
|---|
| 165 |
|
|---|
| 166 | <para><command>ip monitor</command> allows users to continously monitor
|
|---|
| 167 | the state of devices, addresses and routes</para>
|
|---|
| 168 | <indexterm zone="ch-system-iproute2 ip">
|
|---|
| 169 | <primary sortas="b-ip">ip</primary>
|
|---|
| 170 | </indexterm>
|
|---|
| 171 | </listitem>
|
|---|
| 172 | </varlistentry>
|
|---|
| 173 |
|
|---|
| 174 | <varlistentry id="lnstat">
|
|---|
| 175 | <term><command>lnstat</command></term>
|
|---|
| 176 | <listitem>
|
|---|
| 177 | <para>Provides Linux network statistics. It is a generalized and more
|
|---|
| 178 | feature-complete replacement for the old <command>rtstat</command>
|
|---|
| 179 | program</para>
|
|---|
| 180 | <indexterm zone="ch-system-iproute2 lnstat">
|
|---|
| 181 | <primary sortas="b-lnstat">lnstat</primary>
|
|---|
| 182 | </indexterm>
|
|---|
| 183 | </listitem>
|
|---|
| 184 | </varlistentry>
|
|---|
| 185 |
|
|---|
| 186 | <varlistentry id="nstat">
|
|---|
| 187 | <term><command>nstat</command></term>
|
|---|
| 188 | <listitem>
|
|---|
| 189 | <para>Shows network statistics</para>
|
|---|
| 190 | <indexterm zone="ch-system-iproute2 nstat">
|
|---|
| 191 | <primary sortas="b-nstat">nstat</primary>
|
|---|
| 192 | </indexterm>
|
|---|
| 193 | </listitem>
|
|---|
| 194 | </varlistentry>
|
|---|
| 195 |
|
|---|
| 196 | <varlistentry id="routef">
|
|---|
| 197 | <term><command>routef</command></term>
|
|---|
| 198 | <listitem>
|
|---|
| 199 | <para>A component of <command>ip route</command>. This is for flushing
|
|---|
| 200 | the routing tables</para>
|
|---|
| 201 | <indexterm zone="ch-system-iproute2 routef">
|
|---|
| 202 | <primary sortas="b-routef">routef</primary>
|
|---|
| 203 | </indexterm>
|
|---|
| 204 | </listitem>
|
|---|
| 205 | </varlistentry>
|
|---|
| 206 |
|
|---|
| 207 | <varlistentry id="routel">
|
|---|
| 208 | <term><command>routel</command></term>
|
|---|
| 209 | <listitem>
|
|---|
| 210 | <para>A component of <command>ip route</command>. This is for listing
|
|---|
| 211 | the routing tables</para>
|
|---|
| 212 | <indexterm zone="ch-system-iproute2 routel">
|
|---|
| 213 | <primary sortas="b-routel">routel</primary>
|
|---|
| 214 | </indexterm>
|
|---|
| 215 | </listitem>
|
|---|
| 216 | </varlistentry>
|
|---|
| 217 |
|
|---|
| 218 | <varlistentry id="rtacct">
|
|---|
| 219 | <term><command>rtacct</command></term>
|
|---|
| 220 | <listitem>
|
|---|
| 221 | <para>Displays the contents of
|
|---|
| 222 | <filename>/proc/net/rt_acct</filename></para>
|
|---|
| 223 | <indexterm zone="ch-system-iproute2 rtacct">
|
|---|
| 224 | <primary sortas="b-rtacct">rtacct</primary>
|
|---|
| 225 | </indexterm>
|
|---|
| 226 | </listitem>
|
|---|
| 227 | </varlistentry>
|
|---|
| 228 |
|
|---|
| 229 | <varlistentry id="rtmon">
|
|---|
| 230 | <term><command>rtmon</command></term>
|
|---|
| 231 | <listitem>
|
|---|
| 232 | <para>Route monitoring utility</para>
|
|---|
| 233 | <indexterm zone="ch-system-iproute2 rtmon">
|
|---|
| 234 | <primary sortas="b-rtmon">rtmon</primary>
|
|---|
| 235 | </indexterm>
|
|---|
| 236 | </listitem>
|
|---|
| 237 | </varlistentry>
|
|---|
| 238 |
|
|---|
| 239 | <varlistentry id="rtpr">
|
|---|
| 240 | <term><command>rtpr</command></term>
|
|---|
| 241 | <listitem>
|
|---|
| 242 | <para>Converts the output of <command>ip -o</command> back into a
|
|---|
| 243 | readable form</para>
|
|---|
| 244 | <indexterm zone="ch-system-iproute2 rtpr">
|
|---|
| 245 | <primary sortas="b-rtpr">rtpr</primary>
|
|---|
| 246 | </indexterm>
|
|---|
| 247 | </listitem>
|
|---|
| 248 | </varlistentry>
|
|---|
| 249 |
|
|---|
| 250 | <varlistentry id="rtstat">
|
|---|
| 251 | <term><command>rtstat</command></term>
|
|---|
| 252 | <listitem>
|
|---|
| 253 | <para>Route status utility</para>
|
|---|
| 254 | <indexterm zone="ch-system-iproute2 rtstat">
|
|---|
| 255 | <primary sortas="b-rtstat">rtstat</primary>
|
|---|
| 256 | </indexterm>
|
|---|
| 257 | </listitem>
|
|---|
| 258 | </varlistentry>
|
|---|
| 259 |
|
|---|
| 260 | <varlistentry id="ss">
|
|---|
| 261 | <term><command>ss</command></term>
|
|---|
| 262 | <listitem>
|
|---|
| 263 | <para>Similar to the <command>netstat</command> command; shows
|
|---|
| 264 | active connections</para>
|
|---|
| 265 | <indexterm zone="ch-system-iproute2 ss">
|
|---|
| 266 | <primary sortas="b-ss">ss</primary>
|
|---|
| 267 | </indexterm>
|
|---|
| 268 | </listitem>
|
|---|
| 269 | </varlistentry>
|
|---|
| 270 |
|
|---|
| 271 | <varlistentry id="tc">
|
|---|
| 272 | <term><command>tc</command></term>
|
|---|
| 273 | <listitem>
|
|---|
| 274 | <para>Traffic Controlling Executable; this is for Quality Of Service
|
|---|
| 275 | (QOS) and Class Of Service (COS) implementations</para>
|
|---|
| 276 |
|
|---|
| 277 | <para><command>tc qdisc</command> allows users to setup the queueing
|
|---|
| 278 | discipline</para>
|
|---|
| 279 |
|
|---|
| 280 | <para><command>tc class</command> allows users to setup classes based on
|
|---|
| 281 | the queuing discipline scheduling</para>
|
|---|
| 282 |
|
|---|
| 283 | <para><command>tc estimator</command> allows users to estimate the
|
|---|
| 284 | network flow into a network</para>
|
|---|
| 285 |
|
|---|
| 286 | <para><command>tc filter</command> allows users to setup the QOS/COS
|
|---|
| 287 | packet filtering</para>
|
|---|
| 288 |
|
|---|
| 289 | <para><command>tc policy</command> allows users to setup the QOS/COS
|
|---|
| 290 | policies</para>
|
|---|
| 291 | <indexterm zone="ch-system-iproute2 ss">
|
|---|
| 292 | <primary sortas="b-tc">tc</primary>
|
|---|
| 293 | </indexterm>
|
|---|
| 294 | </listitem>
|
|---|
| 295 | </varlistentry>
|
|---|
| 296 |
|
|---|
| 297 | </variablelist>
|
|---|
| 298 |
|
|---|
| 299 | </sect2>
|
|---|
| 300 |
|
|---|
| 301 | </sect1>
|
|---|
