iproute2.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  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. <title>IPRoute2-&iproute2-version;</title>
  10. <indexterm zone="ch-system-iproute2">
  11. <primary sortas="a-IPRoute2">IPRoute2</primary>
  12. </indexterm>
  13. <sect2 role="package">
  14. <title/>
  15. <para>The IPRoute2 package contains programs for basic and advanced IPV4-based
  16. networking.</para>
  17. <segmentedlist>
  18. <segtitle>&buildtime;</segtitle>
  19. <segtitle>&diskspace;</segtitle>
  20. <seglistitem>
  21. <seg>&iproute2-ch6-sbu;</seg>
  22. <seg>&iproute2-ch6-du;</seg>
  23. </seglistitem>
  24. </segmentedlist>
  25. </sect2>
  26. <sect2 role="installation">
  27. <title>Installation of IPRoute2</title>
  28. <para>Compile the package:</para>
  29. <screen><userinput>make SBINDIR=/sbin</userinput></screen>
  30. <variablelist>
  31. <title>The meaning of the make option:</title>
  32. <varlistentry>
  33. <term><parameter>SBINDIR=/sbin</parameter></term>
  34. <listitem>
  35. <para>This ensures that the IPRoute2 binaries will install into
  36. <filename class="directory">/sbin</filename>. This is the correct
  37. location according to the FHS, because some of the IPRoute2 binaries
  38. are used by the LFS-Bootscripts package.</para>
  39. </listitem>
  40. </varlistentry>
  41. </variablelist>
  42. <para>This package does not come with a test suite.</para>
  43. <para>Install the package:</para>
  44. <screen><userinput>make SBINDIR=/sbin install</userinput></screen>
  45. <para>The <command>arpd</command> binary links against the Berkeley DB
  46. libraries that reside in <filename class="directory">/usr</filename> and
  47. uses a database in <filename>/var/lib/arpd/arpd.db</filename>. Thus,
  48. according to the FHS, it must be in <filename
  49. class="directory">/usr/sbin</filename>. Move it there:</para>
  50. <screen><userinput>mv -v /sbin/arpd /usr/sbin</userinput></screen>
  51. </sect2>
  52. <sect2 id="contents-iproute2" role="content">
  53. <title>Contents of IPRoute2</title>
  54. <segmentedlist>
  55. <segtitle>Installed programs</segtitle>
  56. <seglistitem>
  57. <seg>arpd, ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
  58. nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
  59. and tc.</seg>
  60. </seglistitem>
  61. </segmentedlist>
  62. <variablelist>
  63. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  64. <?dbfo list-presentation="list"?>
  65. <?dbhtml list-presentation="table"?>
  66. <varlistentry id="arpd">
  67. <term><command>arpd</command></term>
  68. <listitem>
  69. <para>Userspace ARP daemon, useful in really large networks, where the
  70. kernelspace ARP implementation is insufficient, or when setting up a
  71. honeypot</para>
  72. <indexterm zone="ch-system-iproute2 arpd">
  73. <primary sortas="b-arpd">arpd</primary>
  74. </indexterm>
  75. </listitem>
  76. </varlistentry>
  77. <varlistentry id="ctstat">
  78. <term><command>ctstat</command></term>
  79. <listitem>
  80. <para>Connection status utility</para>
  81. <indexterm zone="ch-system-iproute2 ctstat">
  82. <primary sortas="b-ctstat">ctstat</primary>
  83. </indexterm>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry id="genl">
  87. <term><command>genl</command></term>
  88. <listitem>
  89. <para></para>
  90. <indexterm zone="ch-system-iproute2 genl">
  91. <primary sortas="b-genl">genl</primary>
  92. </indexterm>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry id="ifcfg">
  96. <term><command>ifcfg</command></term>
  97. <listitem>
  98. <para>A shell script wrapper for the <command>ip</command> command</para>
  99. <indexterm zone="ch-system-iproute2 ifcfg">
  100. <primary sortas="b-ifcfg">ifcfg</primary>
  101. </indexterm>
  102. </listitem>
  103. </varlistentry>
  104. <varlistentry id="ifstat">
  105. <term><command>ifstat</command></term>
  106. <listitem>
  107. <para>Shows the interface statistics, including the amount of
  108. transmitted and received packets by interface</para>
  109. <indexterm zone="ch-system-iproute2 ifstat">
  110. <primary sortas="b-ifstat">ifstat</primary>
  111. </indexterm>
  112. </listitem>
  113. </varlistentry>
  114. <varlistentry id="ip">
  115. <term><command>ip</command></term>
  116. <listitem>
  117. <para>The main executable. It has several different functions:</para>
  118. <para><command>ip link <replaceable>&lt;device&gt;</replaceable></command>
  119. allows users to look at the state of devices and to make changes</para>
  120. <para><command>ip addr</command> allows users to look at addresses and
  121. their properties, add new addresses, and delete old ones</para>
  122. <para><command>ip neighbor</command> allows users to look at neighbor
  123. bindings and their properties, add new neighbor entries, and delete
  124. old ones</para>
  125. <para><command>ip rule</command> allows users to look at the routing
  126. policies and change them</para>
  127. <para><command>ip route</command> allows users to look at the routing
  128. table and change routing table rules</para>
  129. <para><command>ip tunnel</command> allows users to look at the IP
  130. tunnels and their properties, and change them</para>
  131. <para><command>ip maddr</command> allows users to look at the multicast
  132. addresses and their properties, and change them</para>
  133. <para><command>ip mroute</command> allows users to set, change, or
  134. delete the multicast routing</para>
  135. <para><command>ip monitor</command> allows users to continously monitor
  136. the state of devices, addresses and routes</para>
  137. <indexterm zone="ch-system-iproute2 ip">
  138. <primary sortas="b-ip">ip</primary>
  139. </indexterm>
  140. </listitem>
  141. </varlistentry>
  142. <varlistentry id="lnstat">
  143. <term><command>lnstat</command></term>
  144. <listitem>
  145. <para>Provides Linux network statistics. It is a generalized and more
  146. feature-complete replacement for the old <command>rtstat</command>
  147. program</para>
  148. <indexterm zone="ch-system-iproute2 lnstat">
  149. <primary sortas="b-lnstat">lnstat</primary>
  150. </indexterm>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry id="nstat">
  154. <term><command>nstat</command></term>
  155. <listitem>
  156. <para>Shows network statistics</para>
  157. <indexterm zone="ch-system-iproute2 nstat">
  158. <primary sortas="b-nstat">nstat</primary>
  159. </indexterm>
  160. </listitem>
  161. </varlistentry>
  162. <varlistentry id="routef">
  163. <term><command>routef</command></term>
  164. <listitem>
  165. <para>A component of <command>ip route</command>. This is for flushing
  166. the routing tables</para>
  167. <indexterm zone="ch-system-iproute2 routef">
  168. <primary sortas="b-routef">routef</primary>
  169. </indexterm>
  170. </listitem>
  171. </varlistentry>
  172. <varlistentry id="routel">
  173. <term><command>routel</command></term>
  174. <listitem>
  175. <para>A component of <command>ip route</command>. This is for listing
  176. the routing tables</para>
  177. <indexterm zone="ch-system-iproute2 routel">
  178. <primary sortas="b-routel">routel</primary>
  179. </indexterm>
  180. </listitem>
  181. </varlistentry>
  182. <varlistentry id="rtacct">
  183. <term><command>rtacct</command></term>
  184. <listitem>
  185. <para>Displays the contents of
  186. <filename>/proc/net/rt_acct</filename></para>
  187. <indexterm zone="ch-system-iproute2 rtacct">
  188. <primary sortas="b-rtacct">rtacct</primary>
  189. </indexterm>
  190. </listitem>
  191. </varlistentry>
  192. <varlistentry id="rtmon">
  193. <term><command>rtmon</command></term>
  194. <listitem>
  195. <para>Route monitoring utility</para>
  196. <indexterm zone="ch-system-iproute2 rtmon">
  197. <primary sortas="b-rtmon">rtmon</primary>
  198. </indexterm>
  199. </listitem>
  200. </varlistentry>
  201. <varlistentry id="rtpr">
  202. <term><command>rtpr</command></term>
  203. <listitem>
  204. <para>Converts the output of <command>ip -o</command> back into a
  205. readable form</para>
  206. <indexterm zone="ch-system-iproute2 rtpr">
  207. <primary sortas="b-rtpr">rtpr</primary>
  208. </indexterm>
  209. </listitem>
  210. </varlistentry>
  211. <varlistentry id="rtstat">
  212. <term><command>rtstat</command></term>
  213. <listitem>
  214. <para>Route status utility</para>
  215. <indexterm zone="ch-system-iproute2 rtstat">
  216. <primary sortas="b-rtstat">rtstat</primary>
  217. </indexterm>
  218. </listitem>
  219. </varlistentry>
  220. <varlistentry id="ss">
  221. <term><command>ss</command></term>
  222. <listitem>
  223. <para>Similar to the <command>netstat</command> command; shows active
  224. connections</para>
  225. <indexterm zone="ch-system-iproute2 ss">
  226. <primary sortas="b-ss">ss</primary>
  227. </indexterm>
  228. </listitem>
  229. </varlistentry>
  230. <varlistentry id="tc">
  231. <term><command>tc</command></term>
  232. <listitem>
  233. <para>Traffic Controlling Executable; this is for Quality Of Service
  234. (QOS) and Class Of Service (COS) implementations</para>
  235. <para><command>tc qdisc</command> allows users to setup the queueing
  236. discipline</para>
  237. <para><command>tc class</command> allows users to setup classes based
  238. on the queuing discipline scheduling</para>
  239. <para><command>tc estimator</command> allows users to estimate the
  240. network flow into a network</para>
  241. <para><command>tc filter</command> allows users to setup the QOS/COS
  242. packet filtering</para>
  243. <para><command>tc policy</command> allows users to setup the QOS/COS
  244. policies</para>
  245. <indexterm zone="ch-system-iproute2 ss">
  246. <primary sortas="b-tc">tc</primary>
  247. </indexterm>
  248. </listitem>
  249. </varlistentry>
  250. </variablelist>
  251. </sect2>
  252. </sect1>