diff options
Diffstat (limited to 'man/ifplugstatus.8.xml.in')
| -rw-r--r-- | man/ifplugstatus.8.xml.in | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/man/ifplugstatus.8.xml.in b/man/ifplugstatus.8.xml.in new file mode 100644 index 0000000..f7bb62a --- /dev/null +++ b/man/ifplugstatus.8.xml.in @@ -0,0 +1,117 @@ +<?xml version="1.0"?> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- + 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="ifplugstatus" section="8" desc="A link beat detection tool"> + + <synopsis> + <cmd>ifplugstatus [<arg>options</arg>] [<arg>INTERFACE</arg>]</cmd> + </synopsis> + + <description> + <p>ifplugstatus 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 ifplugstatus 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 < 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 > 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 + <@PACKAGE_BUGREPORT@>. ifplugd is available + at <url + href="@PACKAGE_URL@"/> + </p> + </section> + + <section name="See also"> + <p> + <manref name="mii-diag" section="8"/>, <manref name="mii-tool" + section="8"/>, <manref name="ethtool" section="8"/>, <manref name="ifplugd" 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> |