From 86add5ad710adde499af6d08fe5479098dadaf29 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 31 Jul 2003 13:00:31 +0000 Subject: moved to trunk git-svn-id: file:///home/lennart/svn/public/ifplugd/trunk@26 2bf48fe7-cfc1-0310-909f-d9042e1e0fef --- man/Makefile.am | 36 ++++++ man/ifplugd.8.xml.in | 275 ++++++++++++++++++++++++++++++++++++++++++++++ man/ifplugd.conf.5.xml.in | 71 ++++++++++++ man/ifstatus.8.xml.in | 116 +++++++++++++++++++ 4 files changed, 498 insertions(+) create mode 100644 man/Makefile.am create mode 100644 man/ifplugd.8.xml.in create mode 100644 man/ifplugd.conf.5.xml.in create mode 100644 man/ifstatus.8.xml.in (limited to 'man') 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 @@ + + + + + + + + + + + ifplugd [options] + + + +

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.

+ +

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 + (-d option) or plugged whiles (-u + option).

+ +

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

@sysconfdir@/ifplugd/ifplugd.conf: this file is sourced + by the init script @sysconfdir@/init.d/ifplugd and + contains the interface to be monitored and the options to be + used.

+ +

@sysconfdir@/ifplugd/ifplugd.action: 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".

+ +

/var/run/ifplugd.<iface>.pid: the pid file + for ifplugd.

+ +
+ +
+

The action script will be called with two environment variables set:

+ +

IFPLUGD_PREVIOUS The previous link status. Either + "up", "down", "error" or "disabled". The former values should be + obvious, the latter is set on daemon startup.

+ +

IFPLUGD_CURRENT The current link status. See above + for possible values.

+ +
+ +
+

SIGINT, SIGTERM ifplugd will quit, possibly running the shutdown script. This is issued by passing -k to ifplugd.

+

SIGQUIT ifplugd will quit, the shutdown script is never run.

+

SIGHUP ifplugd will write its status information to syslog. This is issued by -z.

+

SIGUSR1 ifplugd will go to suspend mode. (-S)

+

SIGUSR2 ifplugd will resume from suspend mode. (-R)

+
+ +
+

ifplugd was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ifplugd is available + at +

+
+ +
+

+ , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + @sysconfdir@/ifplugd/ifplugd.conf + + + +

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.

+ + + + + + + + + + +
+

+ +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + 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 @@ + + + + + + + + + + + ifstatus [options] [INTERFACE] + + + +

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 + -v)

+ + + + +

You may speicify an ethernet device on the command + line. Otherwise ifstatus will check for eth0..eth9 + automatically.

+ + + + + + + + + + + + + + +
+

0 Success

+

1 Failure

+

2 Link beat detected (only available when an interface is specified)

+

3 Unplugged (same here)

+
+ +
+

ifplugd was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. ifplugd is available + at +

+
+ +
+

+ , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + -- cgit