From 3e05cdd09405cc6133ebf38ea9ee9afc50fb280f Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 4 Aug 2003 22:45:25 +0000 Subject: Initial checkin git-svn-id: file:///home/lennart/svn/public/ifmetric/trunk@3 b1ab5a0b-19c4-0310-9d9a-ef184d715f50 --- doc/README.html.in | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 doc/README.html.in (limited to 'doc/README.html.in') diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..46f4a23 --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,133 @@ + + + + + +ifmetric @PACKAGE_VERSION@ + + + + +

ifmetric @PACKAGE_VERSION@

+ +

Copyright 2003 Lennart Poettering <mzvszrgevp [at] itaparica.org>

+ + + +

License

+ +

This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation; either version 2 of the +License, or (at your option) any later version.

+ +

This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details.

+ +

You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

+ +

News

+ +
Mon Aug 4 2003:

Version +0.1 released

+ +

Overview

+ +

ifmetric is a Linux tool for setting the metrics of all +IPv4 routes attached to a given network interface at once. This +may be used to change the priority of routing IPv4 traffic over +the interface. Lower metrics correlate with higher +priorities.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is stable and feature complete.

+ +

Documentation

+ +

ifmetric's purpose

+ +

Sometimes two network interfaces of different speeds with equal +routes are available at the same time. (e.g. a laptop with both a +wireless and a copper LAN card) The one with the greater througput +should be preferred over the other. To achieve this, you may use the +route's metric field. Routes with lower metrics are preferred over +those with higher. Unfortunately many network configurators (like DHCP +clients) do not support to set the metric for a +route. ifmetric may be used to manipulate the metrics of +routes a posteriori. The default metric for a route in the Linux +kernel is 0, meaning the highest priority.

+ +

ifmetric makes use of the NETLINK interface of the Linux +kernel for manipulating the routes. Thus, ifmetric is +compatible with complex routes created with iproute2.

+ +

ifmetric doesn't modify the routes atomically. The is due +to the NETLINK API. However, this should not hurt since +ifmetric makes sure that not routes are ever lost while +modifying them.

+ +

Usage

+ +

To give all other interfaces a higher priority than wlan0 simply run:

+ +
ifmetric wlan0 1
+ +

To reset the metrics of the routes attached to wlan0 simply run: + +

ifmetric wlan0 0
+ +

Requirements

+ +

A newer Linux Kernel supporting the NETLINK API. (I think 2.2 is +good enough).

+ +

ifmetric was developed and tested on Debian GNU/Linux +"testing" from August 2003, it should work on most other Linux +distributions since it uses GNU autoconf for +source code configuration.

+ +

Installation

+ +

As this package is made with the GNU autotools you should run +./configure inside the distribution directory for configuring +the source tree. After that you should run make for +compilation and make install (as root) for installation of +ifmetric.

+ +

The Linux kernel headers have to be available during compilation.

+ +

Acknowledgements

+ +

For the developers of iproute2 and zebra, since I looked +on their source codes for learning how to use NETLINK.

+ +

Download

+ +

The newest release is always available from http://www.stud.uni-hamburg.de/~lennart/projects/ifmetric/

+ +

The current release is @PACKAGE_VERSION@

+ +
+ +
Lennart Poettering <mzvszrgevp [at] itaparica.org>, July 2003
+ +
$Id$
+ + + -- cgit