moved to trunk

git-svn-id: file:///home/lennart/svn/public/ifplugd/trunk@26 2bf48fe7-cfc1-0310-909f-d9042e1e0fef

4 files changed, 498 insertions, 0 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..1f18593
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,36 @@
+# $Id: Makefile.am 22 2003-06-15 16:36:33Z lennart $
+
+# This file is part of ifplugd.
+#
+# ifplugd 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.
+#
+# ifplugd 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 ifplugd; if not, write to the Free Software Foundation,
+# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+man_MANS = ifplugd.8 ifplugd.conf.5 ifstatus.8
+
+EXTRA_DIST = $(man_MANS) ifplugd.8.xml.in ifplugd.conf.5.xml.in ifstatus.8.xml.in
+
+if USE_XMLTOMAN
+
+CLEANFILES = $(man_MANS)
+
+ifplugd.8: ifplugd.8.xml.in Makefile
+	sed -e 's,@sysconfdir\@,$(sysconfdir),g' -e 's,@sbindir\@,$(sbindir),g' -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' $< | xmltoman - > $@
+
+ifplugd.conf.5: ifplugd.conf.5.xml.in Makefile
+	sed -e 's,@sysconfdir\@,$(sysconfdir),g' -e 's,@sbindir\@,$(sbindir),g' -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' $< | xmltoman - > $@
+
+ifstatus.8: ifstatus.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/ifplugd.8.xml.in b/man/ifplugd.8.xml.in
new file mode 100644
index 0000000..f252121
--- /dev/null
+++ b/man/ifplugd.8.xml.in
@@ -0,0 +1,275 @@
+<?xml version="1.0" standalone='no'?>
+<!DOCTYPE spec SYSTEM "man.dtd">
+
+<!-- $Id: ifplugd.8.xml 1.4 Sat, 01 Feb 2003 03:00:07 +0100 lennart $ -->
+
+<!-- 
+  This file is part of ifplugd.
+
+  ifplugd 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.
+
+  ifplugd 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 ifplugd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+  <manpage name="ifplugd" section="8" desc="A link detection daemon for ethernet devices">
+
+	<synopsis>
+	  <cmd>ifplugd [<arg>options</arg>]</cmd>
+	</synopsis>
+	
+	<description>
+	  <p>ifplugd is a daemon which will automatically configure your
+		ethernet device when a cable is plugged in and automatically
+		unconfigure it if the cable is pulled. This is useful on
+		laptops with on-board network adapters, since it will only
+		configure the interface when a cable is really connected.</p>
+	  
+	  <p>It uses your distribution's native ifup/ifdown programs, but
+		can be configured to do anything you wish when the state of
+		the interface changes. It may ignore short unplugged whiles
+		(<opt>-d</opt> option) or plugged whiles (<opt>-u</opt>
+		option).</p>
+
+      <p>ifplugd may be used in "compatibility mode" by specifying -F
+      on the command line. Than ifplugd will treat network drivers
+      which do not support link beat querying as always online.</p>
+	</description>
+	
+	<options>
+	  
+	  <option>
+		<p><opt>-a | --no-auto</opt></p>
+		<optdesc><p>
+			Do not enable interface automatically (default: off)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-n | --no-daemon</opt></p>
+		<optdesc><p>
+			Do not daemonize (for debugging) (default: off)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-s | --no-syslog</opt></p>
+		<optdesc><p>
+			Do not use syslog, use stdout instead (for debugging) (default: off).
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-b | --no-beep</opt></p>
+		<optdesc><p>
+			Do not beep (off)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-f | --ignore-fail</opt></p>
+		<optdesc><p>
+			Ignore detection failure, retry instead. Failure is treated as "no link". (default: off)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-F | --ignore-fail-positive</opt></p>
+		<optdesc><p>
+			Ignore detection failure, retry instead. Failure is treated as "link detected". (default: off)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-i | --iface=</opt> <arg>IFACE</arg></p>
+		<optdesc><p>
+			Specify ethernet interface (default: eth0)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-r | --run=</opt> <arg>EXEC</arg></p>
+		<optdesc><p>
+			Specify program to execute when link status changes (default: <file>@sysconfdir@/ifplugd/ifplugd.action</file>)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-I | --ignore-retval</opt></p>
+		<optdesc><p>
+			Don't exit on nonzeor return value of program execute don link change. (default: off)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-t | --poll-time=</opt> <arg>SECS</arg></p>
+		<optdesc><p>
+			Specify poll time in seconds (default: 1)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-u | --delay-up=</opt> <arg>SECS</arg></p>
+		<optdesc><p>
+			Specify delay for configuring interface (default: 0)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-d | --delay-down=</opt> <arg>SECS</arg></p>
+		<optdesc><p>
+			Specify delay for deconfiguring interface (default: 5)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-m | --api-mode=</opt> <arg>MODE</arg></p> <optdesc><p>
+		Force a specific link beat detection ioctl() API. Possible
+		values are auto, wlan, ethtool, mii, and priv for automatic
+		detection, wireless extension, SIOCETHTOOL, SIOCGMIIREG
+		resp. SIOCPRIV. Only the first character of the argument is
+		relevant, case insensitive.  (default: auto) </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-q | --no-shutdown</opt></p>
+		<optdesc><p>
+			Don't call the script for network shutdown on deamon quit (default: off)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-w | --wait-on-fork</opt></p> 
+
+		<optdesc><p> When daemonizing, wait until the background
+		process finished with the initial link beat detection. When
+		this is enabled, the parent process will return the link
+		status on exit. 1 means link beat detected, 2 stands for link
+		beat not detected, everything else is an error.
+		</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-x | --extra-arg=</opt> <arg>ARG</arg></p>
+		<optdesc><p>
+			Specify an extra argument to be passed to the action script.
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-h | --help</opt></p>
+		<optdesc><p>
+			Show help
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-k | --kill</opt></p>
+		<optdesc><p>
+			Kill a running daemon (Specify -i to select the daemon instance to kill)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-c | --check-running</opt></p>
+		<optdesc><p>
+			Check if a daemon is running for a given network interface. Sets the return value to 0 if a daemon is already running or to 255 if not.
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-v | --version</opt></p>
+		<optdesc><p>
+			Show version
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-S | --supend</opt></p> <optdesc><p> Suspend a running
+		daemon. The daemon will no longer check the link status until
+		it is resumed (-R) again. (Specify -i to select the daemon instance
+		to suspend.)  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-R | --resume</opt></p> <optdesc><p> Resume a suspended
+		daemon. (Specify -i to select the daemon instance
+		to resume.)  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-z | --info</opt></p> <optdesc><p>Request that a
+		running daemon shall write its status information to
+		syslog. (Specify -i to select the daemon instance to send the
+		request to.)  </p></optdesc>
+	  </option>
+
+	</options>
+	
+	<section name="Files">
+	  
+	  <p><file>@sysconfdir@/ifplugd/ifplugd.conf</file>: this file is sourced
+		by the init script <file>@sysconfdir@/init.d/ifplugd</file> and
+		contains the interface to be monitored and the options to be
+		used.</p>
+	  
+	  <p><file>@sysconfdir@/ifplugd/ifplugd.action</file>: this is the script
+		which will be called by the daemon whenever the state of the
+	 	interface changes. It takes two areguments: the first is the interface
+		name (eg. eth0), the second either "up" or "down". </p>
+		
+	  <p><file>/var/run/ifplugd.&lt;iface&gt;.pid</file>: the pid file
+	  for ifplugd.</p>
+	  
+	</section>
+	
+	<section name="Environment">
+	  <p>The action script will be called with two environment variables set:</p>
+
+	  <p><arg>IFPLUGD_PREVIOUS</arg> The previous link status. Either
+	  "up", "down", "error" or "disabled". The former values should be
+	  obvious, the latter is set on daemon startup.</p>
+
+	  <p><arg>IFPLUGD_CURRENT</arg> The current link status. See above
+	  for possible values.</p>
+
+	</section>
+
+    <section name="Signals">
+      <p><arg>SIGINT, SIGTERM</arg> ifplugd will quit, possibly running the shutdown script. This is issued by passing -k to ifplugd.</p>
+      <p><arg>SIGQUIT</arg> ifplugd will quit, the shutdown script is never run.</p>
+      <p><arg>SIGHUP</arg> ifplugd will write its status information to syslog. This is issued by -z.</p>
+      <p><arg>SIGUSR1</arg> ifplugd will go to suspend mode. (-S)</p>
+      <p><arg>SIGUSR2</arg> ifplugd will resume from suspend mode. (-R)</p>
+    </section>
+
+	<section name="Author">
+	  <p>ifplugd was written by Lennart Poettering
+		&lt;@PACKAGE_BUGREPORT@&gt;. ifplugd is available
+		at <url
+		href="http://www.stud.uni-hamburg.de/users/lennart/projects/ifplugd/"/>
+	  </p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+		<manref name="ifplugd.conf" section="5"/>, <manref name="ifup" section="8"/>, <manref name="interfaces"
+		  section="5"/>, <manref name="ifconfig" section="8"/>
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xmltoman" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>
diff --git a/man/ifplugd.conf.5.xml.in b/man/ifplugd.conf.5.xml.in
new file mode 100644
index 0000000..8b580cd
--- /dev/null
+++ b/man/ifplugd.conf.5.xml.in
@@ -0,0 +1,71 @@
+<?xml version="1.0" standalone='no'?>
+<!DOCTYPE spec SYSTEM "man.dtd">
+
+<!-- $Id: ifplugd.conf.5.xml 1.2 Wed, 23 Oct 2002 20:49:08 +0200 lennart $ -->
+
+<!-- 
+  This file is part of ifplugd.
+
+  ifplugd 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.
+
+  ifplugd 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 ifplugd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+  <manpage name="ifplugd.conf" section="5" desc="ifplugd configuration file">
+
+	<synopsis>
+	  <cmd>@sysconfdir@/ifplugd/ifplugd.conf</cmd>
+	</synopsis>
+	
+	<description>
+	  <p>ifplugd.conf is the configuration file for ifplugd. It is a
+	  shell script that is sourced by the init script starting
+	  the daemon. It shall be used to set two environment variables which
+	  are interpreted by the init script.</p>
+	</description>
+	
+	<options>
+
+	  <option>
+		<p><opt>INTERFACES</opt></p> <optdesc><p>Specifies the
+		ethernet interfaces to monitor. It has to contain a space
+		seperated list of network interfaces names. Most users will
+		probably use "eth0" here, however you may add additional
+		interfaces for monitoring more than one device. A special
+		value is supported as well: "auto" will enable a more or less
+		working auto detection of available network devices. This
+		won't make you happy when using network module auto loading,
+		since it cannot detect currently unloaded network
+		devices.</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>ARGS</opt></p> <optdesc><p>Additional command line
+		arguments for ifplugd invocation. See <manref name="ifplugd"
+		section="8"/> for further information.</p></optdesc>
+	  </option>
+
+	</options>
+	
+	<section name="See also">
+	  <p>
+		<manref name="ifplugd" section="8"/>
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xmltoman" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>
diff --git a/man/ifstatus.8.xml.in b/man/ifstatus.8.xml.in
new file mode 100644
index 0000000..85bc127
--- /dev/null
+++ b/man/ifstatus.8.xml.in
@@ -0,0 +1,116 @@
+<?xml version="1.0" standalone='no'?>
+<!DOCTYPE spec SYSTEM "man.dtd">
+
+<!-- $Id: ifstatus.8.xml 1.3 Fri, 25 Oct 2002 21:12:38 +0200 lennart $ -->
+
+<!-- 
+  This file is part of ifplugd.
+
+  ifplugd 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.
+
+  ifplugd 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 ifplugd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+  <manpage name="ifstatus" section="8" desc="A link beat detection tool">
+
+	<synopsis>
+	  <cmd>ifstatus [<arg>options</arg>] [<arg>INTERFACE</arg>]</cmd>
+	</synopsis>
+	
+	<description>
+	  <p>ifstatus is an utility which may be used to detect the link
+	  status of a local Linux ethernet device, much in the same way
+	  mii-diag, mii-tool and ethtool work. In fact it supports all
+	  three different APIs these three tools use. Thus, it provides
+	  maximal compatibility. The newest API (ethtool) is used first,
+	  than the next older (mii-diag) and at last the oldest
+	  (mii-tool). It may be used in shell script since it returns the
+	  current status as return value. It is especially useful to
+	  detect the available APIs on the used network driver. (Option 
+	  <opt>-v</opt>)</p>
+	</description>
+	
+	<options>
+
+	  <p>You may speicify an ethernet device on the command
+	  line. Otherwise ifstatus will check for eth0..eth9
+	  automatically.</p>
+	  
+	  <option>
+		<p><opt>-a | --auto</opt></p>
+		<optdesc><p>
+			Enable interface automatically before querying (default: off)
+		  </p></optdesc>
+	  </option>
+	  
+
+	  <option>
+		<p><opt>-h | --help</opt></p>
+		<optdesc><p>
+			Show help
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-q | --quiet</opt></p> <optdesc><p>Decrease verbosity
+		by one. If the verbosity is &lt; 0, no text will be shown,
+		only the return value is relevant; if the verbosity is = 0, a
+		terse status will be shown; If the verbosity is &gt; 0,
+		detailed information about the used API is returned. (By
+		default the verbosity is 0)</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-v | --verbose</opt></p>
+		<optdesc><p>
+			Increase verbosity by one. See option <opt>-q</opt>.
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-V | --version</opt></p>
+		<optdesc><p>
+			Show version
+		  </p></optdesc>
+	  </option>
+	  
+	</options>
+	
+	<section name="Return values">
+	  <p><arg>0</arg> Success</p>
+	  <p><arg>1</arg> Failure</p>
+	  <p><arg>2</arg> Link beat detected (only available when an interface is specified)</p>
+	  <p><arg>3</arg> Unplugged (same here)</p>
+	</section>
+	
+	<section name="Author">
+	  <p>ifplugd was written by Lennart Poettering
+		&lt;@PACKAGE_BUGREPORT@&gt;.  ifplugd is available
+		at <url
+		href="http://www.stud.uni-hamburg.de/users/lennart/projects/ifplugd/"/>
+	  </p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+		<manref name="mii-diag" section="8"/>, <manref name="mii-tool"
+		  section="8"/>, <manref name="ethtool" section="8"/>
+	  </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>