Initial checkin

git-svn-id: file:///home/lennart/svn/public/ifmetric/trunk@3 b1ab5a0b-19c4-0310-9d9a-ef184d715f50

2 files changed, 103 insertions, 0 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..26be22c
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,30 @@
+# $Id$
+
+# This file is part of ifmetric.
+#
+# ifmetric 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.
+#
+# ifmetric 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 ifmetric; if not, write to the Free Software Foundation,
+# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+man_MANS = ifmetric.8
+
+EXTRA_DIST = $(man_MANS) ifmetric.8.xml.in
+
+if USE_XMLTOMAN
+
+CLEANFILES = $(man_MANS)
+
+ifmetric.8: ifmetric.8.xml.in Makefile
+	sed -e 's,@sysconfdir\@,$(sysconfdir),g' -e 's,@sbindir\@,$(sbindir),g' -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' $< | xmltoman - > $@
+
+endif
diff --git a/man/ifmetric.8.xml.in b/man/ifmetric.8.xml.in
new file mode 100644
index 0000000..050cb4d
--- /dev/null
+++ b/man/ifmetric.8.xml.in
@@ -0,0 +1,73 @@
+<?xml version="1.0" standalone='no'?>
+<!DOCTYPE spec SYSTEM "man.dtd">
+
+<!-- $Id$ -->
+
+<!-- 
+  This file is part of ifmetric.
+
+  ifmetric 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.
+
+  ifmetric 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 ifmetric; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+  <manpage name="ifmetric" section="8" desc="An IPv4 route metrics manipulation tool">
+
+	<synopsis>
+	  <cmd>ifmetric <arg>INTERFACE</arg> [<arg>METRIC</arg>]</cmd>
+	</synopsis>
+	
+	<description> <p>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.</p>
+
+      <p>ifmetric uses the Linux NETLINK interface to manipulate the
+     routes. Because of that it is compatible with routes created with
+     the new iproute2 utility.</p>
+    </description>
+	
+	<options>
+
+	  <p>You should specify the interface name as first parameter. The
+	  second parameter should be the new metric. If ommited the metric
+	  0 (highest) is used.</p>
+	  
+	</options>
+	
+	<section name="Return values">
+	  <p><arg>0</arg> Success</p>
+	  <p><arg>1</arg> Failure</p>
+	</section>
+	
+	<section name="Author">
+	  <p>ifmetric was written by Lennart Poettering
+		&lt;@PACKAGE_BUGREPORT@&gt;.  ifmetric is available
+		at <url
+		href="http://www.stud.uni-hamburg.de/users/lennart/projects/ifmetric/"/>
+	  </p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+		<manref name="route" section="8"/>, iproute2
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xml2man" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>