iproute2.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>4.3 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 <command>sed</command> 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/server/databases.html#db"/>.
  41. </para>
  42. <screen><userinput>sed -i '/^TARGETS/s@arpd@@g' misc/Makefile</userinput></screen>
  43. <para>Prepare IPRoute2 for compilation:</para>
  44. <screen><userinput>chmod u+x configure &amp;&amp;
  45. ./configure</userinput></screen>
  46. <para>Compile the package:</para>
  47. <screen><userinput>make SBINDIR=/sbin</userinput></screen>
  48. <para>The meaning of the make option:</para>
  49. <variablelist>
  50. <varlistentry>
  51. <term><parameter>SBINDIR=/sbin</parameter></term>
  52. <listitem><para>This ensures that the IPRoute2 binaries will install into
  53. <filename class="directory">/sbin</filename>. This is the correct location
  54. according to the FHS, because some of the IPRoute2 binaries are used by
  55. the LFS-Bootscripts package.</para>
  56. </listitem>
  57. </varlistentry>
  58. </variablelist>
  59. <para>Install the package:</para>
  60. <screen><userinput>make SBINDIR=/sbin install</userinput></screen>
  61. </sect2>
  62. <sect2 id="contents-iproute2" role="content">
  63. <title>Contents of IPRoute2</title>
  64. <segmentedlist>
  65. <segtitle>Installed programs</segtitle>
  66. <seglistitem>
  67. <seg>ctstat (link to lnstat), ifcfg, ifstat, ip, lnstat, nstat, routef,
  68. routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss, and tc.
  69. </seg>
  70. </seglistitem>
  71. </segmentedlist>
  72. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  73. <?dbfo list-presentation="list"?>
  74. <?dbhtml list-presentation="table"?>
  75. <varlistentry id="ctstat">
  76. <term>
  77. <command>ctstat</command>
  78. </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="ifcfg">
  87. <term>
  88. <command>ifcfg</command>
  89. </term>
  90. <listitem>
  91. <para>A shell script wrapper for the <command>ip</command> command</para>
  92. <indexterm zone="ch-system-iproute2 ifcfg">
  93. <primary sortas="b-ifcfg">ifcfg</primary>
  94. </indexterm>
  95. </listitem>
  96. </varlistentry>
  97. <varlistentry id="ifstat">
  98. <term>
  99. <command>ifstat</command>
  100. </term>
  101. <listitem>
  102. <para>Shows the interface statistics, including the amount of transmitted
  103. and received packets by interface</para>
  104. <indexterm zone="ch-system-iproute2 ifstat">
  105. <primary sortas="b-ifstat">ifstat</primary>
  106. </indexterm>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry id="ip">
  110. <term>
  111. <command>ip</command>
  112. </term>
  113. <listitem>
  114. <para>The main executable. It has several different functions:</para>
  115. <para><command>ip link <replaceable>[device]</replaceable></command>
  116. allows users to look at the state of devices and to make changes
  117. </para>
  118. <para><command>ip addr</command> allows users to look at addresses and
  119. their properties, add new addresses, and delete old ones
  120. </para>
  121. <para><command>ip neighbor</command> allows users to look at
  122. neighbor bindings and their properties, add new
  123. neighbor entries, and delete old ones
  124. </para>
  125. <para><command>ip rule</command> allows users to look at the routing
  126. policies and change them
  127. </para>
  128. <para><command>ip route</command> allows users to look at the routing
  129. table and change routing table rules
  130. </para>
  131. <para><command>ip tunnel</command> allows users to look at the IP
  132. tunnels and their properties, and change them
  133. </para>
  134. <para><command>ip maddr</command> allows users to look at the multicast
  135. addresses and their properties, and change them
  136. </para>
  137. <para><command>ip mroute</command> allows users to set, change, or
  138. delete the multicast routing
  139. </para>
  140. <para><command>ip monitor</command> allows users to
  141. continously monitor the state of devices, addresses and routes
  142. </para>
  143. <indexterm zone="ch-system-iproute2 ip">
  144. <primary sortas="b-ip">ip</primary>
  145. </indexterm>
  146. </listitem>
  147. </varlistentry>
  148. <varlistentry id="lnstat">
  149. <term>
  150. <command>lnstat</command>
  151. </term>
  152. <listitem>
  153. <para>Provides Linux network statistics. It is a generalized and more
  154. feature-complete replacement for the old
  155. <command>rtstat</command> program</para>
  156. <indexterm zone="ch-system-iproute2 lnstat">
  157. <primary sortas="b-lnstat">lnstat</primary>
  158. </indexterm>
  159. </listitem>
  160. </varlistentry>
  161. <varlistentry id="nstat">
  162. <term>
  163. <command>nstat</command>
  164. </term>
  165. <listitem>
  166. <para>Shows network statistics</para>
  167. <indexterm zone="ch-system-iproute2 nstat">
  168. <primary sortas="b-nstat">nstat</primary>
  169. </indexterm>
  170. </listitem>
  171. </varlistentry>
  172. <varlistentry id="routef">
  173. <term>
  174. <command>routef</command>
  175. </term>
  176. <listitem>
  177. <para>A component of <command>ip route</command>. This is for flushing the routing
  178. tables
  179. </para>
  180. <indexterm zone="ch-system-iproute2 routef">
  181. <primary sortas="b-routef">routef</primary>
  182. </indexterm>
  183. </listitem>
  184. </varlistentry>
  185. <varlistentry id="routel">
  186. <term>
  187. <command>routel</command>
  188. </term>
  189. <listitem>
  190. <para>A component of <command>ip route</command>. This is for listing the routing
  191. tables
  192. </para>
  193. <indexterm zone="ch-system-iproute2 routel">
  194. <primary sortas="b-routel">routel</primary>
  195. </indexterm>
  196. </listitem>
  197. </varlistentry>
  198. <varlistentry id="rtacct">
  199. <term>
  200. <command>rtacct</command>
  201. </term>
  202. <listitem>
  203. <para>Displays the contents of <filename>/proc/net/rt_acct</filename></para>
  204. <indexterm zone="ch-system-iproute2 rtacct">
  205. <primary sortas="b-rtacct">rtacct</primary>
  206. </indexterm>
  207. </listitem>
  208. </varlistentry>
  209. <varlistentry id="rtmon">
  210. <term>
  211. <command>rtmon</command>
  212. </term>
  213. <listitem>
  214. <para>Route monitoring utility</para>
  215. <indexterm zone="ch-system-iproute2 rtmon">
  216. <primary sortas="b-rtmon">rtmon</primary>
  217. </indexterm>
  218. </listitem>
  219. </varlistentry>
  220. <varlistentry id="rtpr">
  221. <term>
  222. <command>rtpr</command>
  223. </term>
  224. <listitem>
  225. <para>Converts the output of <command>ip -o</command> back into a
  226. readable form</para>
  227. <indexterm zone="ch-system-iproute2 rtpr">
  228. <primary sortas="b-rtpr">rtpr</primary>
  229. </indexterm>
  230. </listitem>
  231. </varlistentry>
  232. <varlistentry id="rtstat">
  233. <term>
  234. <command>rtstat</command>
  235. </term>
  236. <listitem>
  237. <para>Route status utility</para>
  238. <indexterm zone="ch-system-iproute2 rtstat">
  239. <primary sortas="b-rtstat">rtstat</primary>
  240. </indexterm>
  241. </listitem>
  242. </varlistentry>
  243. <varlistentry id="ss">
  244. <term>
  245. <command>ss</command>
  246. </term>
  247. <listitem>
  248. <para>Similar to the <command>netstat</command> command; shows active connections</para>
  249. <indexterm zone="ch-system-iproute2 ss">
  250. <primary sortas="b-ss">ss</primary>
  251. </indexterm>
  252. </listitem>
  253. </varlistentry>
  254. <varlistentry id="tc">
  255. <term>
  256. <command>tc</command>
  257. </term>
  258. <listitem>
  259. <para>Traffic Controlling Executable; this is for Quality Of
  260. Service (QOS) and Class Of Service (COS)
  261. implementations
  262. </para>
  263. <para><command>tc qdisc</command> allows users to setup the queueing
  264. discipline
  265. </para>
  266. <para><command>tc class</command> allows users to setup classes based on
  267. the queuing discipline scheduling
  268. </para>
  269. <para><command>tc estimator</command> allows users to estimate the
  270. network flow into a network
  271. </para>
  272. <para><command>tc filter</command> allows users to setup the QOS/COS
  273. packet filtering
  274. </para>
  275. <para><command>tc policy</command> allows users to setup the QOS/COS
  276. policies
  277. </para>
  278. <indexterm zone="ch-system-iproute2 ss">
  279. <primary sortas="b-tc">tc</primary>
  280. </indexterm>
  281. </listitem>
  282. </varlistentry>
  283. </variablelist>
  284. </sect2>
  285. </sect1>