iproute2.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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. <sect1 id="ch-system-iproute2" role="wrap">
  8. <?dbhtml filename="iproute2.html"?>
  9. <sect1info condition="script">
  10. <productname>iproute2</productname>
  11. <productnumber>&iproute2-version;</productnumber>
  12. <address>&iproute2-url;</address>
  13. </sect1info>
  14. <title>IPRoute2-&iproute2-version;</title>
  15. <indexterm zone="ch-system-iproute2">
  16. <primary sortas="a-IPRoute2">IPRoute2</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The IPRoute2 package contains programs for basic and advanced IPV4-based
  21. networking.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&iproute2-ch6-sbu;</seg>
  27. <seg>&iproute2-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of IPRoute2</title>
  33. <para>The <command>arpd</command> binary included in this package is
  34. dependent on Berkeley DB. Because <command>arpd</command> is not a very
  35. common requirement on a base Linux system, remove the dependency on Berkeley
  36. DB by applying the commands below. If the <command>arpd</command> binary is
  37. needed, instructions for compiling Berkeley DB can be found in the BLFS Book
  38. at <ulink url="&blfs-root;view/svn/server/databases.html#db"/>.
  39. </para>
  40. <screen><userinput remap="pre">sed -i '/^TARGETS/s@arpd@@g' misc/Makefile
  41. sed -i /ARPD/d Makefile
  42. sed -i 's/arpd.8//' man/man8/Makefile</userinput></screen>
  43. <para>Compile the package:</para>
  44. <screen><userinput remap="make">make DESTDIR=</userinput></screen>
  45. <variablelist>
  46. <title>The meaning of the make option:</title>
  47. <varlistentry>
  48. <term><parameter>DESTDIR=</parameter></term>
  49. <listitem>
  50. <para>This ensures that the IPRoute2 binaries will install into
  51. the correct directory. By default, <parameter>DESTDIR</parameter> is
  52. set to <filename class="directory">/usr</filename>.</para>
  53. </listitem>
  54. </varlistentry>
  55. </variablelist>
  56. <para>This package comes with a test suite, but due to assumptions it makes,
  57. it is not possible to reliably run these tests from within the chroot
  58. environment. If you wish to run these tests after booting into your new LFS
  59. system, ensure you select <filename>/proc/config.gz</filename>
  60. CONFIG_IKCONFIG_PROC (&quot;General setup&quot; -> &quot;Enable access to
  61. .config through /proc/config.gz&quot;) support into your kernel then run
  62. 'make alltests' from the <filename class="directory">testsuite/</filename>
  63. subdirectory.</para>
  64. <para>Install the package:</para>
  65. <screen><userinput remap="install">make DESTDIR= \
  66. MANDIR=/usr/share/man \
  67. DOCDIR=/usr/share/doc/iproute2-&iproute2-version; install</userinput></screen>
  68. </sect2>
  69. <sect2 id="contents-iproute2" role="content">
  70. <title>Contents of IPRoute2</title>
  71. <segmentedlist>
  72. <segtitle>Installed programs</segtitle>
  73. <segtitle>Installed directories</segtitle>
  74. <seglistitem>
  75. <seg>ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
  76. nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
  77. and tc</seg>
  78. <seg>/etc/iproute2, /lib/tc, /usr/share/doc/iproute2-&iproute2-version;,
  79. /usr/lib/tc</seg>
  80. </seglistitem>
  81. </segmentedlist>
  82. <variablelist>
  83. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  84. <?dbfo list-presentation="list"?>
  85. <?dbhtml list-presentation="table"?>
  86. <varlistentry id="ctstat">
  87. <term><command>ctstat</command></term>
  88. <listitem>
  89. <para>Connection status utility</para>
  90. <indexterm zone="ch-system-iproute2 ctstat">
  91. <primary sortas="b-ctstat">ctstat</primary>
  92. </indexterm>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry id="genl">
  96. <term><command>genl</command></term>
  97. <listitem>
  98. <para></para>
  99. <indexterm zone="ch-system-iproute2 genl">
  100. <primary sortas="b-genl">genl</primary>
  101. </indexterm>
  102. </listitem>
  103. </varlistentry>
  104. <varlistentry id="ifcfg">
  105. <term><command>ifcfg</command></term>
  106. <listitem>
  107. <para>A shell script wrapper for the <command>ip</command> command.
  108. Note that it requires the <command>arping</command> and
  109. <command>rdisk</command> programs from the
  110. iputils package found at <ulink url="http://www.skbuff.net/iputils/"/>.</para>
  111. <indexterm zone="ch-system-iproute2 ifcfg">
  112. <primary sortas="b-ifcfg">ifcfg</primary>
  113. </indexterm>
  114. </listitem>
  115. </varlistentry>
  116. <varlistentry id="ifstat">
  117. <term><command>ifstat</command></term>
  118. <listitem>
  119. <para>Shows the interface statistics, including the amount of
  120. transmitted and received packets by interface</para>
  121. <indexterm zone="ch-system-iproute2 ifstat">
  122. <primary sortas="b-ifstat">ifstat</primary>
  123. </indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="ip">
  127. <term><command>ip</command></term>
  128. <listitem>
  129. <para>The main executable. It has several different functions:</para>
  130. <para><command>ip link <replaceable>&lt;device&gt;</replaceable></command>
  131. allows users to look at the state of devices and to make changes</para>
  132. <para><command>ip addr</command> allows users to look at addresses and
  133. their properties, add new addresses, and delete old ones</para>
  134. <para><command>ip neighbor</command> allows users to look at neighbor
  135. bindings and their properties, add new neighbor entries, and delete
  136. old ones</para>
  137. <para><command>ip rule</command> allows users to look at the routing
  138. policies and change them</para>
  139. <para><command>ip route</command> allows users to look at the routing
  140. table and change routing table rules</para>
  141. <para><command>ip tunnel</command> allows users to look at the IP
  142. tunnels and their properties, and change them</para>
  143. <para><command>ip maddr</command> allows users to look at the multicast
  144. addresses and their properties, and change them</para>
  145. <para><command>ip mroute</command> allows users to set, change, or
  146. delete the multicast routing</para>
  147. <para><command>ip monitor</command> allows users to continously monitor
  148. the state of devices, addresses and routes</para>
  149. <indexterm zone="ch-system-iproute2 ip">
  150. <primary sortas="b-ip">ip</primary>
  151. </indexterm>
  152. </listitem>
  153. </varlistentry>
  154. <varlistentry id="lnstat">
  155. <term><command>lnstat</command></term>
  156. <listitem>
  157. <para>Provides Linux network statistics. It is a generalized and more
  158. feature-complete replacement for the old <command>rtstat</command>
  159. program</para>
  160. <indexterm zone="ch-system-iproute2 lnstat">
  161. <primary sortas="b-lnstat">lnstat</primary>
  162. </indexterm>
  163. </listitem>
  164. </varlistentry>
  165. <varlistentry id="nstat">
  166. <term><command>nstat</command></term>
  167. <listitem>
  168. <para>Shows network statistics</para>
  169. <indexterm zone="ch-system-iproute2 nstat">
  170. <primary sortas="b-nstat">nstat</primary>
  171. </indexterm>
  172. </listitem>
  173. </varlistentry>
  174. <varlistentry id="routef">
  175. <term><command>routef</command></term>
  176. <listitem>
  177. <para>A component of <command>ip route</command>. This is for flushing
  178. the routing tables</para>
  179. <indexterm zone="ch-system-iproute2 routef">
  180. <primary sortas="b-routef">routef</primary>
  181. </indexterm>
  182. </listitem>
  183. </varlistentry>
  184. <varlistentry id="routel">
  185. <term><command>routel</command></term>
  186. <listitem>
  187. <para>A component of <command>ip route</command>. This is for listing
  188. the routing tables</para>
  189. <indexterm zone="ch-system-iproute2 routel">
  190. <primary sortas="b-routel">routel</primary>
  191. </indexterm>
  192. </listitem>
  193. </varlistentry>
  194. <varlistentry id="rtacct">
  195. <term><command>rtacct</command></term>
  196. <listitem>
  197. <para>Displays the contents of
  198. <filename>/proc/net/rt_acct</filename></para>
  199. <indexterm zone="ch-system-iproute2 rtacct">
  200. <primary sortas="b-rtacct">rtacct</primary>
  201. </indexterm>
  202. </listitem>
  203. </varlistentry>
  204. <varlistentry id="rtmon">
  205. <term><command>rtmon</command></term>
  206. <listitem>
  207. <para>Route monitoring utility</para>
  208. <indexterm zone="ch-system-iproute2 rtmon">
  209. <primary sortas="b-rtmon">rtmon</primary>
  210. </indexterm>
  211. </listitem>
  212. </varlistentry>
  213. <varlistentry id="rtpr">
  214. <term><command>rtpr</command></term>
  215. <listitem>
  216. <para>Converts the output of <command>ip -o</command> back into a
  217. readable form</para>
  218. <indexterm zone="ch-system-iproute2 rtpr">
  219. <primary sortas="b-rtpr">rtpr</primary>
  220. </indexterm>
  221. </listitem>
  222. </varlistentry>
  223. <varlistentry id="rtstat">
  224. <term><command>rtstat</command></term>
  225. <listitem>
  226. <para>Route status utility</para>
  227. <indexterm zone="ch-system-iproute2 rtstat">
  228. <primary sortas="b-rtstat">rtstat</primary>
  229. </indexterm>
  230. </listitem>
  231. </varlistentry>
  232. <varlistentry id="ss">
  233. <term><command>ss</command></term>
  234. <listitem>
  235. <para>Similar to the <command>netstat</command> command; shows active
  236. connections</para>
  237. <indexterm zone="ch-system-iproute2 ss">
  238. <primary sortas="b-ss">ss</primary>
  239. </indexterm>
  240. </listitem>
  241. </varlistentry>
  242. <varlistentry id="tc">
  243. <term><command>tc</command></term>
  244. <listitem>
  245. <para>Traffic Controlling Executable; this is for Quality Of Service
  246. (QOS) and Class Of Service (COS) implementations</para>
  247. <para><command>tc qdisc</command> allows users to setup the queueing
  248. discipline</para>
  249. <para><command>tc class</command> allows users to setup classes based
  250. on the queuing discipline scheduling</para>
  251. <para><command>tc estimator</command> allows users to estimate the
  252. network flow into a network</para>
  253. <para><command>tc filter</command> allows users to setup the QOS/COS
  254. packet filtering</para>
  255. <para><command>tc policy</command> allows users to setup the QOS/COS
  256. policies</para>
  257. <indexterm zone="ch-system-iproute2 ss">
  258. <primary sortas="b-tc">tc</primary>
  259. </indexterm>
  260. </listitem>
  261. </varlistentry>
  262. </variablelist>
  263. </sect2>
  264. </sect1>