[3f8be484] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
---|
[aa18ac0] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
---|
[3f8be484] | 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 |
---|
[3373dd11] | 21 | IPV4-based networking.</para> |
---|
[3f8be484] | 22 | |
---|
| 23 | </sect2> |
---|
| 24 | |
---|
| 25 | <sect2 role="installation"> |
---|
| 26 | <title>Installation of IPRoute2</title> |
---|
| 27 | |
---|
[e0e40d3] | 28 | <para os="s1">The <command>arpd</command> binary included in this package is |
---|
[3f8be484] | 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 |
---|
[161cb88] | 33 | compiling Berkeley DB can be found in CBLFS at <ulink |
---|
[0d4607d] | 34 | url="&cblfs-root;index.php/Berkeley_DB"/>.</para> |
---|
[3f8be484] | 35 | |
---|
[e0e40d3] | 36 | <screen os="s2"><userinput>sed -i '/^TARGETS/s@arpd@@g' misc/Makefile</userinput></screen> |
---|
[3f8be484] | 37 | |
---|
[8cd6d31] | 38 | <para os="a">Compile the package:</para> |
---|
[3f8be484] | 39 | |
---|
[8ced986] | 40 | <screen os="b"><userinput>make DESTDIR= DOCDIR=/usr/share/doc/iproute2 \ |
---|
[10a8dea] | 41 | MANDIR=/usr/share/man</userinput></screen> |
---|
[3f8be484] | 42 | |
---|
[8cd6d31] | 43 | <variablelist os="c"> |
---|
[3f8be484] | 44 | <title>The meaning of the make option:</title> |
---|
| 45 | |
---|
| 46 | <varlistentry> |
---|
[8ced986] | 47 | <term><parameter>DESTDIR=</parameter></term> |
---|
[3f8be484] | 48 | <listitem> |
---|
[4fdeb4ea] | 49 | <para>This option overrides the default DESTDIR of /usr, so that |
---|
| 50 | that the IPRoute2 binaries will be installed into |
---|
[3f8be484] | 51 | <filename class="directory">/sbin</filename>. This is the correct |
---|
| 52 | location according to the FHS, because some of the IPRoute2 binaries |
---|
[fb40919] | 53 | are used by the CLFS-Bootscripts package.</para> |
---|
[3f8be484] | 54 | </listitem> |
---|
| 55 | </varlistentry> |
---|
[4fdeb4ea] | 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 |
---|
[7bca962] | 61 | installed into <filename class="directory">/share/doc</filename> and |
---|
| 62 | <filename class="directory">/share/man</filename>. These options |
---|
| 63 | ensure the docs are installed to the correct locations.</para> |
---|
[4fdeb4ea] | 64 | </listitem> |
---|
| 65 | </varlistentry> |
---|
[3f8be484] | 66 | </variablelist> |
---|
| 67 | |
---|
[8cd6d31] | 68 | <para os="d">This package does not come with a test suite.</para> |
---|
[3f8be484] | 69 | |
---|
[8cd6d31] | 70 | <para os="e">Install the package:</para> |
---|
[d1631d1] | 71 | |
---|
[8ced986] | 72 | <screen os="f"><userinput>make DESTDIR= DOCDIR=/usr/share/doc/iproute2 \ |
---|
[10a8dea] | 73 | MANDIR=/usr/share/man install</userinput></screen> |
---|
[3f8be484] | 74 | |
---|
| 75 | </sect2> |
---|
| 76 | |
---|
| 77 | <sect2 id="contents-iproute2" role="content"> |
---|
| 78 | <title>Contents of IPRoute2</title> |
---|
| 79 | |
---|
| 80 | <segmentedlist> |
---|
| 81 | <segtitle>Installed programs</segtitle> |
---|
| 82 | |
---|
| 83 | <seglistitem> |
---|
[427015f] | 84 | <seg>ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat, nstat, |
---|
[3f8be484] | 85 | routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss, |
---|
| 86 | and tc</seg> |
---|
| 87 | </seglistitem> |
---|
| 88 | </segmentedlist> |
---|
| 89 | |
---|
| 90 | <variablelist> |
---|
| 91 | <bridgehead renderas="sect3">Short Descriptions</bridgehead> |
---|
| 92 | <?dbfo list-presentation="list"?> |
---|
| 93 | <?dbhtml list-presentation="table"?> |
---|
| 94 | |
---|
| 95 | <varlistentry id="ctstat"> |
---|
| 96 | <term><command>ctstat</command></term> |
---|
| 97 | <listitem> |
---|
| 98 | <para>Connection status utility</para> |
---|
| 99 | <indexterm zone="ch-system-iproute2 ctstat"> |
---|
[a68b59e] | 100 | <primary sortas="b-ctstat">ctstat</primary> |
---|
[3f8be484] | 101 | </indexterm> |
---|
| 102 | </listitem> |
---|
| 103 | </varlistentry> |
---|
| 104 | |
---|
[427015f] | 105 | <varlistentry id="genl"> |
---|
| 106 | <term><command>genl</command></term> |
---|
| 107 | <listitem> |
---|
| 108 | <para>Needs description</para> |
---|
| 109 | <indexterm zone="ch-system-iproute2 genl"> |
---|
| 110 | <primary sortas="b-genl">genl</primary> |
---|
| 111 | </indexterm> |
---|
| 112 | </listitem> |
---|
| 113 | </varlistentry> |
---|
| 114 | |
---|
[3f8be484] | 115 | <varlistentry id="ifcfg"> |
---|
| 116 | <term><command>ifcfg</command></term> |
---|
| 117 | <listitem> |
---|
| 118 | <para>A shell script wrapper for the <command>ip</command> |
---|
| 119 | command</para> |
---|
| 120 | <indexterm zone="ch-system-iproute2 ifcfg"> |
---|
| 121 | <primary sortas="b-ifcfg">ifcfg</primary> |
---|
| 122 | </indexterm> |
---|
| 123 | </listitem> |
---|
| 124 | </varlistentry> |
---|
| 125 | |
---|
| 126 | <varlistentry id="ifstat"> |
---|
| 127 | <term><command>ifstat</command></term> |
---|
| 128 | <listitem> |
---|
| 129 | <para>Shows the interface statistics, including the amount of |
---|
| 130 | transmitted and received packets by interface</para> |
---|
| 131 | <indexterm zone="ch-system-iproute2 ifstat"> |
---|
| 132 | <primary sortas="b-ifstat">ifstat</primary> |
---|
| 133 | </indexterm> |
---|
| 134 | </listitem> |
---|
| 135 | </varlistentry> |
---|
| 136 | |
---|
| 137 | <varlistentry id="ip"> |
---|
| 138 | <term><command>ip</command></term> |
---|
| 139 | <listitem> |
---|
| 140 | <para>The main executable. It has several different functions:</para> |
---|
| 141 | |
---|
| 142 | <para><command>ip link <replaceable>[device]</replaceable></command> |
---|
| 143 | allows users to look at the state of devices and to make changes</para> |
---|
| 144 | |
---|
| 145 | <para><command>ip addr</command> allows users to look at addresses and |
---|
| 146 | their properties, add new addresses, and delete old ones</para> |
---|
| 147 | |
---|
| 148 | <para><command>ip neighbor</command> allows users to look at neighbor |
---|
| 149 | bindings and their properties, add new neighbor entries, and delete |
---|
| 150 | old ones</para> |
---|
| 151 | |
---|
| 152 | <para><command>ip rule</command> allows users to look at the routing |
---|
| 153 | policies and change them</para> |
---|
| 154 | |
---|
| 155 | <para><command>ip route</command> allows users to look at the routing |
---|
| 156 | table and change routing table rules</para> |
---|
| 157 | |
---|
| 158 | <para><command>ip tunnel</command> allows users to look at the IP |
---|
| 159 | tunnels and their properties, and change them</para> |
---|
| 160 | |
---|
| 161 | <para><command>ip maddr</command> allows users to look at the multicast |
---|
| 162 | addresses and their properties, and change them</para> |
---|
| 163 | |
---|
| 164 | <para><command>ip mroute</command> allows users to set, change, or |
---|
| 165 | delete the multicast routing</para> |
---|
| 166 | |
---|
| 167 | <para><command>ip monitor</command> allows users to continously monitor |
---|
| 168 | the state of devices, addresses and routes</para> |
---|
| 169 | <indexterm zone="ch-system-iproute2 ip"> |
---|
| 170 | <primary sortas="b-ip">ip</primary> |
---|
| 171 | </indexterm> |
---|
| 172 | </listitem> |
---|
| 173 | </varlistentry> |
---|
| 174 | |
---|
| 175 | <varlistentry id="lnstat"> |
---|
| 176 | <term><command>lnstat</command></term> |
---|
| 177 | <listitem> |
---|
| 178 | <para>Provides Linux network statistics. It is a generalized and more |
---|
| 179 | feature-complete replacement for the old <command>rtstat</command> |
---|
| 180 | program</para> |
---|
| 181 | <indexterm zone="ch-system-iproute2 lnstat"> |
---|
[a68b59e] | 182 | <primary sortas="b-lnstat">lnstat</primary> |
---|
[3f8be484] | 183 | </indexterm> |
---|
| 184 | </listitem> |
---|
| 185 | </varlistentry> |
---|
| 186 | |
---|
| 187 | <varlistentry id="nstat"> |
---|
| 188 | <term><command>nstat</command></term> |
---|
| 189 | <listitem> |
---|
| 190 | <para>Shows network statistics</para> |
---|
| 191 | <indexterm zone="ch-system-iproute2 nstat"> |
---|
| 192 | <primary sortas="b-nstat">nstat</primary> |
---|
| 193 | </indexterm> |
---|
| 194 | </listitem> |
---|
| 195 | </varlistentry> |
---|
| 196 | |
---|
| 197 | <varlistentry id="routef"> |
---|
| 198 | <term><command>routef</command></term> |
---|
| 199 | <listitem> |
---|
| 200 | <para>A component of <command>ip route</command>. This is for flushing |
---|
| 201 | the routing tables</para> |
---|
| 202 | <indexterm zone="ch-system-iproute2 routef"> |
---|
| 203 | <primary sortas="b-routef">routef</primary> |
---|
| 204 | </indexterm> |
---|
| 205 | </listitem> |
---|
| 206 | </varlistentry> |
---|
| 207 | |
---|
| 208 | <varlistentry id="routel"> |
---|
| 209 | <term><command>routel</command></term> |
---|
| 210 | <listitem> |
---|
| 211 | <para>A component of <command>ip route</command>. This is for listing |
---|
| 212 | the routing tables</para> |
---|
| 213 | <indexterm zone="ch-system-iproute2 routel"> |
---|
| 214 | <primary sortas="b-routel">routel</primary> |
---|
| 215 | </indexterm> |
---|
| 216 | </listitem> |
---|
| 217 | </varlistentry> |
---|
| 218 | |
---|
| 219 | <varlistentry id="rtacct"> |
---|
| 220 | <term><command>rtacct</command></term> |
---|
| 221 | <listitem> |
---|
| 222 | <para>Displays the contents of |
---|
| 223 | <filename>/proc/net/rt_acct</filename></para> |
---|
| 224 | <indexterm zone="ch-system-iproute2 rtacct"> |
---|
| 225 | <primary sortas="b-rtacct">rtacct</primary> |
---|
| 226 | </indexterm> |
---|
| 227 | </listitem> |
---|
| 228 | </varlistentry> |
---|
| 229 | |
---|
| 230 | <varlistentry id="rtmon"> |
---|
| 231 | <term><command>rtmon</command></term> |
---|
| 232 | <listitem> |
---|
| 233 | <para>Route monitoring utility</para> |
---|
| 234 | <indexterm zone="ch-system-iproute2 rtmon"> |
---|
| 235 | <primary sortas="b-rtmon">rtmon</primary> |
---|
| 236 | </indexterm> |
---|
| 237 | </listitem> |
---|
| 238 | </varlistentry> |
---|
| 239 | |
---|
| 240 | <varlistentry id="rtpr"> |
---|
| 241 | <term><command>rtpr</command></term> |
---|
| 242 | <listitem> |
---|
| 243 | <para>Converts the output of <command>ip -o</command> back into a |
---|
| 244 | readable form</para> |
---|
| 245 | <indexterm zone="ch-system-iproute2 rtpr"> |
---|
| 246 | <primary sortas="b-rtpr">rtpr</primary> |
---|
| 247 | </indexterm> |
---|
| 248 | </listitem> |
---|
| 249 | </varlistentry> |
---|
| 250 | |
---|
| 251 | <varlistentry id="rtstat"> |
---|
| 252 | <term><command>rtstat</command></term> |
---|
| 253 | <listitem> |
---|
| 254 | <para>Route status utility</para> |
---|
| 255 | <indexterm zone="ch-system-iproute2 rtstat"> |
---|
| 256 | <primary sortas="b-rtstat">rtstat</primary> |
---|
| 257 | </indexterm> |
---|
| 258 | </listitem> |
---|
| 259 | </varlistentry> |
---|
| 260 | |
---|
| 261 | <varlistentry id="ss"> |
---|
| 262 | <term><command>ss</command></term> |
---|
| 263 | <listitem> |
---|
| 264 | <para>Similar to the <command>netstat</command> command; shows |
---|
| 265 | active connections</para> |
---|
| 266 | <indexterm zone="ch-system-iproute2 ss"> |
---|
| 267 | <primary sortas="b-ss">ss</primary> |
---|
| 268 | </indexterm> |
---|
| 269 | </listitem> |
---|
| 270 | </varlistentry> |
---|
| 271 | |
---|
| 272 | <varlistentry id="tc"> |
---|
| 273 | <term><command>tc</command></term> |
---|
| 274 | <listitem> |
---|
| 275 | <para>Traffic Controlling Executable; this is for Quality Of Service |
---|
| 276 | (QOS) and Class Of Service (COS) implementations</para> |
---|
| 277 | |
---|
| 278 | <para><command>tc qdisc</command> allows users to setup the queueing |
---|
| 279 | discipline</para> |
---|
| 280 | |
---|
| 281 | <para><command>tc class</command> allows users to setup classes based on |
---|
| 282 | the queuing discipline scheduling</para> |
---|
| 283 | |
---|
| 284 | <para><command>tc estimator</command> allows users to estimate the |
---|
| 285 | network flow into a network</para> |
---|
| 286 | |
---|
| 287 | <para><command>tc filter</command> allows users to setup the QOS/COS |
---|
| 288 | packet filtering</para> |
---|
| 289 | |
---|
| 290 | <para><command>tc policy</command> allows users to setup the QOS/COS |
---|
| 291 | policies</para> |
---|
| 292 | <indexterm zone="ch-system-iproute2 ss"> |
---|
| 293 | <primary sortas="b-tc">tc</primary> |
---|
| 294 | </indexterm> |
---|
| 295 | </listitem> |
---|
| 296 | </varlistentry> |
---|
| 297 | |
---|
| 298 | </variablelist> |
---|
| 299 | |
---|
| 300 | </sect2> |
---|
| 301 | |
---|
| 302 | </sect1> |
---|