1ifplugstatus(8)             System Manager's Manual            ifplugstatus(8)
2
3
4

NAME

6       ifplugstatus - A link beat detection tool
7

SYNOPSIS

9       ifplugstatus [options] [INTERFACE]
10

DESCRIPTION

12       ifplugstatus  is an utility which may be used to detect the link status
13       of a local Linux ethernet device, much in the same way  mii-diag,  mii-
14       tool  and  ethtool  work.  In fact it supports all three different APIs
15       these three tools use. In addition it supports link checking  with  the
16       IFF_RUNNING  interface flag, which most modern drivers (not only ether‐
17       net) support, and association status checking with the wireless  exten‐
18       sion API for WLAN devices.
19
20       The APIs are tried in the following order:
21
22       First the newest API: SIOCETHTOOL (aka ethtool API)
23
24       Second the next older API: SIOCGMIIREG (aka mii-diag API)
25
26       Than the WLAN API: wireless extension (aka iwconfig API)
27
28       Followed by the cleanest API: IFF_RUNNING (aka ifconfig API)
29
30       The  oldest  API  (SIOCPRIV aka mii-tool API) is not tested since it is
31       obsolete.
32
33       ifplugstatus may be used in shell script since it returns  the  current
34       status as return value. It is especially useful to detect the available
35       APIs on the used network driver. (Option -v)
36

OPTIONS

38       You may specify an ethernet  device  on  the  command  line.  Otherwise
39       ifplugstatus will check all available network interfaces.
40
41       -a | --auto
42              Enable interface automatically before querying (default: off)
43
44       -h | --help
45              Show help
46
47       -q | --quiet
48              Decrease verbosity by one. If the verbosity is < 0, no text will
49              be shown, only the return value is relevant; if the verbosity is
50              =  0,  a  terse  status  will be shown; If the verbosity is > 0,
51              detailed information about the used API is returned. (By default
52              the verbosity is 0)
53
54       -v | --verbose
55              Increase verbosity by one. See option -q.
56
57       -V | --version
58              Show version
59

RETURN VALUES

61       0 Success
62
63       1 Failure
64
65       2 Link beat detected (only available when an interface is specified)
66
67       3 Unplugged (same here)
68

AUTHOR

70       ifplugd  was  written  by  Lennart  Poettering <mzvscyhtq (at) 0pointer
71       (dot)        de>.        ifplugd        is         available         at
72       http://0pointer.de/lennart/projects/ifplugd/
73

SEE ALSO

75       mii-diag(8), mii-tool(8), ethtool(8), ifplugd(8)
76

COMMENTS

78       This man page was written using xml2man(1) by Oliver Kurth.
79
80
81
82Manuals                              User                      ifplugstatus(8)
Impressum