summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/ifplugd.8.xml.in4
-rw-r--r--man/ifplugstatus.8.xml.in18
2 files changed, 16 insertions, 6 deletions
diff --git a/man/ifplugd.8.xml.in b/man/ifplugd.8.xml.in
index 4b57aef..e720ce2 100644
--- a/man/ifplugd.8.xml.in
+++ b/man/ifplugd.8.xml.in
@@ -136,8 +136,8 @@
<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
+ values are auto, iff, wlan, ethtool, mii, and priv for automatic
+ detection, interface flag (IFF_RUNNING), wireless extension, SIOCETHTOOL, SIOCGMIIREG
resp. SIOCPRIV. Only the first character of the argument is
relevant, case insensitive. (default: auto) </p></optdesc>
</option>
diff --git a/man/ifplugstatus.8.xml.in b/man/ifplugstatus.8.xml.in
index 1f4aed8..684ba02 100644
--- a/man/ifplugstatus.8.xml.in
+++ b/man/ifplugstatus.8.xml.in
@@ -32,10 +32,20 @@
<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
+ three different APIs these three tools use. In addition it supports
+ link checking with the IFF_RUNNING interface flag, which most modern
+ drivers (not only ethernet) support, and association status checking
+ with the wireless extension API for WLAN devices.</p>
+
+ <p>The APIs are tried in the following order:</p>
+
+ <p>First the cleanest API: <arg>IFF_RUNNING</arg> (aka ifconfig API)</p>
+ <p>Second the newest API: <arg>SIOCETHTOOL</arg> (aka ethtool API)</p>
+ <p>Third the next older API: <arg>SIOCGMIIREG</arg> (aka mii-diag API)</p>
+ <p>Than the WLAN API: <arg>wireless extension</arg> (aka iwconfig API)</p>
+ <p>Finally the oldest API: <arg>SIOCPRIV</arg> (aka mii-tool API)</p>
+
+ <p>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>