iproute2.xml 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-iproute2" role="wrap">
  7. <title>Iproute2-&iproute2-version;</title>
  8. <?dbhtml filename="iproute2.html"?>
  9. <indexterm zone="ch-system-iproute2">
  10. <primary sortas="a-iproute2">Iproute2</primary>
  11. </indexterm>
  12. <sect2 role="package">
  13. <title/>
  14. <para>The Iproute2 package contains programs for basic and advanced
  15. IPV4-based networking.
  16. </para>
  17. <segmentedlist>
  18. <segtitle>&buildtime;</segtitle>
  19. <segtitle>&diskspace;</segtitle>
  20. <seglistitem>
  21. <seg>0.1 SBU</seg>
  22. <seg>.6 MB</seg>
  23. </seglistitem>
  24. </segmentedlist>
  25. <segmentedlist>
  26. <segtitle>&dependencies;</segtitle>
  27. <seglistitem>
  28. <seg>GCC, Glibc, Make, Linux-Headers, and Sed</seg>
  29. </seglistitem>
  30. </segmentedlist>
  31. </sect2>
  32. <sect2 role="installation">
  33. <title>Installation of Iproute2</title>
  34. <para>The <command>arpd</command> binary included in this package is
  35. dependent on Berkeley DB. Because <command>arpd</command> is not a very
  36. common requirement on a base Linux system, remove the dependency on
  37. Berkeley DB by applying the patch using the command below. If
  38. the <command>arpd</command> binary is needed, instructions for
  39. compiling Berkeley DB can be found in the BLFS Book at <ulink
  40. url="&blfs-root;view/svn/content/databases.html#db"/>.
  41. </para>
  42. <screen><userinput>patch -Np1 -i ../iproute2-&iproute2-patch-version;-remove_db-1.patch</userinput></screen>
  43. <para>The patch below fixes the issue with the newer versions of
  44. Findutils whose <command>find</command> command will report an error
  45. message when its options are not in the proper order.</para>
  46. <screen><userinput>patch -Np1 -i ../iproute2-&iproute2-patch-version;-find_update-1.patch</userinput></screen>
  47. <para>Prepare Iproute2 for compilation:</para>
  48. <screen><userinput>./configure </userinput></screen>
  49. <para>Compile the package:</para>
  50. <screen><userinput>make SBINDIR=/sbin</userinput></screen>
  51. <para>The meaning of the make option:</para>
  52. <variablelist>
  53. <varlistentry>
  54. <term><parameter>SBINDIR=/sbin</parameter></term>
  55. <listitem><para>This makes sure that the Iproute2 binaries will install into
  56. <filename class="directory">/sbin</filename>. This is the correct
  57. location according to the FHS, because some of the Iproute2 binaries are used
  58. in the bootscripts.</para>
  59. </listitem>
  60. </varlistentry>
  61. </variablelist>
  62. <para>Install the package:</para>
  63. <screen><userinput>make SBINDIR=/sbin install</userinput></screen>
  64. </sect2>
  65. <sect2 id="contents-iproute2" role="content">
  66. <title>Contents of Iproute2</title>
  67. <segmentedlist>
  68. <segtitle>Installed programs</segtitle>
  69. <seglistitem>
  70. <seg>ifstat, ip, nstat, routef, routel, rtmon, rtstat, ss, and tc.</seg>
  71. </seglistitem>
  72. </segmentedlist>
  73. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  74. <?dbfo list-presentation="list"?>
  75. <?dbhtml list-presentation="table"?>
  76. <varlistentry id="ifstat">
  77. <term>
  78. <command>ifstat</command>
  79. </term>
  80. <listitem>
  81. <para>Shows the interfaces statistic, including the amount of transmitted
  82. and received packages by interface.</para>
  83. <indexterm zone="ch-system-iproute2 ifstat">
  84. <primary sortas="b-ifstat">ifstat</primary>
  85. </indexterm>
  86. </listitem>
  87. </varlistentry>
  88. <varlistentry id="ip">
  89. <term>
  90. <command>ip</command>
  91. </term>
  92. <listitem>
  93. <para>The main executable. It has several different functions:</para>
  94. <para><command>ip link <replaceable>[device]</replaceable></command>
  95. allows users to look at the state of devices and to make changes.
  96. </para>
  97. <para><command>ip addr</command> allows users to look at addresses and
  98. their properties, add new addresses, and delete old ones.
  99. </para>
  100. <para><command>ip neighbor</command> allows users to look at
  101. neighbor bindings and their properties, add new
  102. neighbor entries, and delete old ones.
  103. </para>
  104. <para><command>ip rule</command> allows users to look at the routing
  105. policies and change them.
  106. </para>
  107. <para><command>ip route</command> allows users to look at the routing
  108. table and change routing table rules.
  109. </para>
  110. <para><command>ip tunnel</command> allows users to look at the IP
  111. tunnels and their properties, and change them.
  112. </para>
  113. <para><command>ip maddr</command> allows users to look at the multicast
  114. addresses and their properties, and change them.
  115. </para>
  116. <para><command>ip mroute</command> allows users to set, change, or
  117. delete the multicast routing.
  118. </para>
  119. <para><command>ip monitor</command> allows users to
  120. continously monitor the state of devices, addresses and routes.
  121. </para>
  122. <indexterm zone="ch-system-iproute2 ip">
  123. <primary sortas="b-ip">ip</primary>
  124. </indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="nstat">
  128. <term>
  129. <command>nstat</command>
  130. </term>
  131. <listitem>
  132. <para>Shows network statistics.</para>
  133. <indexterm zone="ch-system-iproute2 nstat">
  134. <primary sortas="b-nstat">nstat</primary>
  135. </indexterm>
  136. </listitem>
  137. </varlistentry>
  138. <varlistentry id="routef">
  139. <term>
  140. <command>routef</command>
  141. </term>
  142. <listitem>
  143. <para>A component of <command>ip route</command>. This is for flushing the routing
  144. tables.
  145. </para>
  146. <indexterm zone="ch-system-iproute2 routef">
  147. <primary sortas="b-routef">routef</primary>
  148. </indexterm>
  149. </listitem>
  150. </varlistentry>
  151. <varlistentry id="routel">
  152. <term>
  153. <command>routel</command>
  154. </term>
  155. <listitem>
  156. <para>A component of <command>ip route</command>. This is for listing the routing
  157. tables.
  158. </para>
  159. <indexterm zone="ch-system-iproute2 routel">
  160. <primary sortas="b-routel">routel</primary>
  161. </indexterm>
  162. </listitem>
  163. </varlistentry>
  164. <varlistentry id="rtmon">
  165. <term>
  166. <command>rtmon</command>
  167. </term>
  168. <listitem>
  169. <para>Route monitoring utility.</para>
  170. <indexterm zone="ch-system-iproute2 rtmon">
  171. <primary sortas="b-rtmon">rtmon</primary>
  172. </indexterm>
  173. </listitem>
  174. </varlistentry>
  175. <varlistentry id="rtstat">
  176. <term>
  177. <command>rtstat</command>
  178. </term>
  179. <listitem>
  180. <para>Route status utility</para>
  181. <indexterm zone="ch-system-iproute2 rtstat">
  182. <primary sortas="b-rtstat">rtstat</primary>
  183. </indexterm>
  184. </listitem>
  185. </varlistentry>
  186. <varlistentry id="ss">
  187. <term>
  188. <command>ss</command>
  189. </term>
  190. <listitem>
  191. <para>Similar to the <command>netstat</command> command; shows active connections</para>
  192. <indexterm zone="ch-system-iproute2 ss">
  193. <primary sortas="b-ss">ss</primary>
  194. </indexterm>
  195. </listitem>
  196. </varlistentry>
  197. <varlistentry id="tc">
  198. <term>
  199. <command>tc</command>
  200. </term>
  201. <listitem>
  202. <para>Traffic Controlling Executable; this is for Quality Of
  203. Service (QOS) and Class Of Service (COS)
  204. implementations
  205. </para>
  206. <para><command>tc qdisc</command> allows users to setup the queueing
  207. discipline
  208. </para>
  209. <para><command>tc class</command> allows users to setup classes based on
  210. the queuing discipline scheduling
  211. </para>
  212. <para><command>tc estimator</command> allows users to estimate the
  213. network flow into a network
  214. </para>
  215. <para><command>tc filter</command> allows users to setup the QOS/COS
  216. packet filtering
  217. </para>
  218. <para><command>tc policy</command> allows users to setup the QOS/COS
  219. policies
  220. </para>
  221. <indexterm zone="ch-system-iproute2 ss">
  222. <primary sortas="b-tc">tc</primary>
  223. </indexterm>
  224. </listitem>
  225. </varlistentry>
  226. </variablelist>
  227. </sect2>
  228. </sect1>