source: trunk/third/ifplugd/man/ifplugstatus.8 @ 20388

Revision 20388, 1.8 KB checked in by amb, 20 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r20387, which included commits to RCS files with non-trunk default branches.
Line 
1.TH ifplugstatus 8 User Manuals
2.SH NAME
3ifplugstatus \- A link beat detection tool
4.SH SYNOPSIS
5\fBifplugstatus [\fIoptions\fB] [\fIINTERFACE\fB]
6\f1
7.SH DESCRIPTION
8ifplugstatus 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 \fB-v\f1)
9.SH OPTIONS
10You may specify an ethernet device on the command line. Otherwise ifplugstatus will check all available network interfaces.
11.TP
12\fB-a | --auto\f1
13Enable interface automatically before querying (default: off)
14.TP
15\fB-h | --help\f1
16Show help
17.TP
18\fB-q | --quiet\f1
19Decrease 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)
20.TP
21\fB-v | --verbose\f1
22Increase verbosity by one. See option \fB-q\f1.
23.TP
24\fB-V | --version\f1
25Show version
26.SH RETURN VALUES
27\fI0\f1 Success
28
29\fI1\f1 Failure
30
31\fI2\f1 Link beat detected (only available when an interface is specified)
32
33\fI3\f1 Unplugged (same here)
34.SH AUTHOR
35ifplugd was written by Lennart Poettering <mzvscyhtq (at) 0pointer (dot) de>. ifplugd is available at \fBhttp://0pointer.de/lennart/projects/ifplugd/\f1
36.SH SEE ALSO
37\fBmii-diag(8)\f1, \fBmii-tool(8)\f1, \fBethtool(8)\f1, \fBifplugd(8)\f1
38.SH COMMENTS
39This man page was written using \fBxml2man(1)\f1 by Oliver Kurth.
Note: See TracBrowser for help on using the repository browser.