README.html 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <?xml version="1.0" encoding="iso-8895-15"?> <!-- -*-html-helper-*- -->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>ifmetric 0.3</title>
  6. <link rel="stylesheet" type="text/css" href="style.css" />
  7. </head>
  8. <body>
  9. <h1><a name="top">ifmetric 0.3</a></h1>
  10. <p><i>Copyright 2003,2004 Lennart Poettering &lt;mzvszrgevp (at) 0pointer (dot) de&gt;</i></p>
  11. <ul class="toc">
  12. <li><a href="#license">License</a></li>
  13. <li><a href="#news">News</a></li>
  14. <li><a href="#overview">Overview</a></li>
  15. <li><a href="#status">Status</a></li>
  16. <li><a href="#documentation">Documentation</a></li>
  17. <li><a href="#requirements">Requirements</a></li>
  18. <li><a href="#installation">Installation</a></li>
  19. <li><a href="#acks">Acknowledgements</a></li>
  20. <li><a href="#download">Download</a></li>
  21. </ul>
  22. <h2><a name="license">License</a></h2>
  23. <p>This program is free software; you can redistribute it and/or
  24. modify it under the terms of the GNU General Public License as
  25. published by the Free Software Foundation; either version 2 of the
  26. License, or (at your option) any later version.</p>
  27. <p>This program is distributed in the hope that it will be useful, but
  28. WITHOUT ANY WARRANTY; without even the implied warranty of
  29. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  30. General Public License for more details.</p>
  31. <p>You should have received a copy of the GNU General Public License
  32. along with this program; if not, write to the Free Software
  33. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
  34. <h2><a name="news">News</a></h2>
  35. <div class="news-date">Sat Jan 24 2004: </div> <p class="news-text"><a
  36. href="http://0pointer.de/lennart/projects/ifmetric/ifmetric-0.3.tar.gz">Version
  37. 0.3</a> release; fix compatibility with Linux 2.6</p>
  38. <div class="news-date">Sat Aug 23 2003: </div> <p class="news-text"><a
  39. href="http://0pointer.de/lennart/projects/ifmetric/ifmetric-0.2b.tar.gz">Version
  40. 0.2b</a> release; URL fix</p>
  41. <div class="news-date">Sat Aug 23 2003: </div> <p class="news-text"><a
  42. href="http://0pointer.de/lennart/projects/ifmetric/ifmetric-0.2.tar.gz">Version
  43. 0.2</a> released; changes include updated documentation, build system, contact information</p>
  44. <div class="news-date">Mon Aug 4 2003: </div> <p class="news-text"><a
  45. href="http://0pointer.de/lennart/projects/ifmetric/ifmetric-0.1.tar.gz">Version
  46. 0.1</a> released</p>
  47. <h2><a name="overview">Overview</a></h2>
  48. <p><tt>ifmetric</tt> is a Linux tool for setting the metrics of all
  49. IPv4 routes attached to a given network interface at once. This
  50. may be used to change the priority of routing IPv4 traffic over
  51. the interface. Lower metrics correlate with higher
  52. priorities.</p>
  53. <h2><a name="status">Status</a></h2>
  54. <p>Version 0.3 is stable and feature complete.</p>
  55. <h2><a name="documentation">Documentation</a></h2>
  56. <h3><tt>ifmetric</tt>'s purpose</h3>
  57. <p>Sometimes two network interfaces of different speeds with equal
  58. routes are available at the same time. (e.g. a laptop with both a
  59. wireless and a copper LAN card) The one with the greater througput
  60. should be preferred over the other. To achieve this, you may use the
  61. route's metric field. Routes with lower metrics are preferred over
  62. those with higher. Unfortunately many network configurators (like DHCP
  63. clients) do not support to set the metric for a
  64. route. <tt>ifmetric</tt> may be used to manipulate the metrics of
  65. routes a posteriori. The default metric for a route in the Linux
  66. kernel is 0, meaning the highest priority.</p>
  67. <p><tt>ifmetric</tt> makes use of the NETLINK interface of the Linux
  68. kernel for manipulating the routes. Thus, <tt>ifmetric</tt> is
  69. compatible with complex routes created with <tt>iproute2</tt>.</p>
  70. <p><tt>ifmetric</tt> doesn't modify the routes atomically. The is due
  71. to the NETLINK API. However, this should not hurt since
  72. <tt>ifmetric</tt> makes sure that not routes are ever lost while
  73. modifying them.</p>
  74. <h3>Usage</h3>
  75. <p>Have a look on the manual page <a href="http://0pointer.de/lennart/projects/ifmetric/ifmetric.8.xml"><tt>ifmetric(8)</tt></a>.
  76. <p>To give all other interfaces a higher priority than <tt>wlan0</tt> simply run:</p>
  77. <pre>ifmetric wlan0 1</pre>
  78. <p>To reset the metrics of the routes attached to <tt>wlan0</tt> simply run:</p>
  79. <pre>ifmetric wlan0 0</pre>
  80. <h2><a name="requirements">Requirements</a></h2>
  81. <p>A newer Linux Kernel supporting the NETLINK API. (I think 2.2 is
  82. good enough).</p>
  83. <p><tt>ifmetric</tt> was developed and tested on Debian GNU/Linux
  84. "testing" from August 2003, it should work on most other Linux
  85. distributions since it uses GNU autoconf for
  86. source code configuration.</p>
  87. <h2><a name="installation">Installation</a></h2>
  88. <p>As this package is made with the GNU autotools you should run
  89. <tt>./configure</tt> inside the distribution directory for configuring
  90. the source tree. After that you should run <tt>make</tt> for
  91. compilation and <tt>make install</tt> (as root) for installation of
  92. <tt>ifmetric</tt>.</p>
  93. <p>The Linux kernel headers have to be available during compilation.</p>
  94. <h2><a name="acks">Acknowledgements</a></h2>
  95. <p>For the developers of <tt>iproute2</tt> and <tt>zebra</tt>, since I looked
  96. on their source codes for learning how to use NETLINK.</p>
  97. <h2><a name="download">Download</a></h2>
  98. <p>The newest release is always available from <a href="http://0pointer.de/lennart/projects/ifmetric/">http://0pointer.de/lennart/projects/ifmetric/</a></p>
  99. <p>The current release is <a href="http://0pointer.de/lennart/projects/ifmetric/ifmetric-0.3.tar.gz">0.3</a></p>
  100. <p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/ifmetric/">Freshmeat</a>.</p>
  101. <hr/>
  102. <address class="grey">Lennart Poettering &lt;mzvszrgevp (at) 0pointer (dot) de&gt;, January 2004</address>
  103. <div class="grey"><i>$Id: README.html.in 16 2004-01-23 23:20:25Z lennart $</i></div>
  104. </body>
  105. </html>