source: trunk/third/ifplugd/man/ifplugd.8.xml.in @ 20388

Revision 20388, 8.9 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<?xml version="1.0" standalone='no'?>
2<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
4
5<!-- $Id: ifplugd.8.xml.in,v 1.1.1.1 2004-04-09 20:09:08 amb Exp $ -->
6
7<!--
8  This file is part of ifplugd.
9
10  ifplugd is free software; you can redistribute it and/or modify it under
11  the terms of the GNU General Public License as published by the Free
12  Software Foundation; either version 2 of the License, or (at your
13  option) any later version.
14
15  ifplugd is distributed in the hope that it will be useful, but WITHOUT
16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18  for more details.
19
20  You should have received a copy of the GNU General Public License
21  along with ifplugd; if not, write to the Free Software Foundation,
22  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23-->
24
25  <manpage name="ifplugd" section="8" desc="A link detection daemon for ethernet devices">
26
27        <synopsis>
28          <cmd>ifplugd [<arg>options</arg>]</cmd>
29        </synopsis>
30       
31        <description>
32          <p>ifplugd is a daemon which will automatically configure your
33                ethernet device when a cable is plugged in and automatically
34                unconfigure it if the cable is pulled. This is useful on
35                laptops with on-board network adapters, since it will only
36                configure the interface when a cable is really connected.</p>
37         
38          <p>It uses your distribution's native ifup/ifdown programs, but
39                can be configured to do anything you wish when the state of
40                the interface changes. It may ignore short unplugged whiles
41                (<opt>-d</opt> option) or plugged whiles (<opt>-u</opt> option).</p>
42
43      <p>ifplugd may be used in "compatibility mode" by specifying -F
44      on the command line. Than ifplugd will treat network drivers
45      which do not support link beat querying as always online.</p>
46
47
48</description>
49       
50        <options>
51         
52          <option>
53                <p><opt>-a | --no-auto</opt></p>
54                <optdesc><p>
55                        Do not enable interface automatically (default: off)
56                  </p></optdesc>
57          </option>
58         
59          <option>
60                <p><opt>-n | --no-daemon</opt></p>
61                <optdesc><p>
62                        Do not daemonize (for debugging) (default: off)
63                  </p></optdesc>
64          </option>
65         
66          <option>
67                <p><opt>-s | --no-syslog</opt></p>
68                <optdesc><p>
69                        Do not use syslog, use stdout instead (for debugging) (default: off).
70                  </p></optdesc>
71          </option>
72         
73          <option>
74                <p><opt>-b | --no-beep</opt></p>
75                <optdesc><p>
76                        Do not beep (off)
77                  </p></optdesc>
78          </option>
79         
80          <option>
81                <p><opt>-f | --ignore-fail</opt></p>
82                <optdesc><p>
83                        Ignore detection failure, retry instead. Failure is treated as "no link". (default: off)
84                  </p></optdesc>
85          </option>
86
87          <option>
88                <p><opt>-F | --ignore-fail-positive</opt></p>
89                <optdesc><p>
90                        Ignore detection failure, retry instead. Failure is treated as "link detected". (default: off)
91                  </p></optdesc>
92          </option>
93         
94          <option>
95                <p><opt>-i | --iface=</opt> <arg>IFACE</arg></p>
96                <optdesc><p>
97                        Specify ethernet interface (default: eth0)
98                  </p></optdesc>
99          </option>
100         
101          <option>
102                <p><opt>-r | --run=</opt> <arg>EXEC</arg></p>
103                <optdesc><p>
104                        Specify program to execute when link status changes (default: <file>@sysconfdir@/ifplugd/ifplugd.action</file>)
105                  </p></optdesc>
106          </option>
107
108          <option>
109                <p><opt>-I | --ignore-retval</opt></p>
110                <optdesc><p>
111                        Don't exit on nonzero return value of program executed on link change. (default: off)
112                  </p></optdesc>
113          </option>
114
115          <option>
116                <p><opt>-t | --poll-time=</opt> <arg>SECS</arg></p>
117                <optdesc><p>
118                        Specify poll time in seconds (default: 1)
119                  </p></optdesc>
120          </option>
121         
122          <option>
123                <p><opt>-u | --delay-up=</opt> <arg>SECS</arg></p>
124                <optdesc><p>
125                        Specify delay for configuring interface (default: 0)
126                  </p></optdesc>
127          </option>
128         
129          <option>
130                <p><opt>-d | --delay-down=</opt> <arg>SECS</arg></p>
131                <optdesc><p>
132                        Specify delay for deconfiguring interface (default: 5)
133                  </p></optdesc>
134          </option>
135         
136          <option>
137                <p><opt>-m | --api-mode=</opt> <arg>MODE</arg></p> <optdesc><p>
138                Force a specific link beat detection ioctl() API. Possible
139                values are auto, wlan, ethtool, mii, and priv for automatic
140                detection, wireless extension, SIOCETHTOOL, SIOCGMIIREG
141                resp. SIOCPRIV. Only the first character of the argument is
142                relevant, case insensitive.  (default: auto) </p></optdesc>
143          </option>
144         
145          <option>
146                <p><opt>-q | --no-shutdown</opt></p>
147                <optdesc><p>
148                        Don't call the script for network shutdown on deamon quit (default: off)
149                  </p></optdesc>
150          </option>
151
152          <option>
153                <p><opt>-w | --wait-on-fork</opt></p>
154
155                <optdesc><p> When daemonizing, wait until the background
156                process finished with the initial link beat detection. When
157                this is enabled, the parent process will return the link
158                status on exit. 1 means link beat detected, 2 stands for link
159                beat not detected, everything else is an error.
160                </p></optdesc>
161          </option>
162
163          <option>
164                <p><opt>-W | --wait-on-kill</opt></p>
165
166                <optdesc><p> When killing a running daemon (with -k) wait
167                until the daemon died.
168        </p></optdesc>
169          </option>
170
171          <option>
172                <p><opt>-x | --extra-arg=</opt> <arg>ARG</arg></p>
173                <optdesc><p>
174                        Specify an extra argument to be passed to the action script.
175                  </p></optdesc>
176          </option>
177
178          <option>
179                <p><opt>-M | --monitor</opt></p>
180                <optdesc><p>
181                        Don't fail when the network interface is not available, instead use NETLINK to monitor device avaibility. The is useful for PCMCIA devices and similar.
182                </p></optdesc>
183          </option>
184         
185          <option>
186                <p><opt>-h | --help</opt></p>
187                <optdesc><p>
188                        Show help
189                  </p></optdesc>
190          </option>
191         
192          <option>
193                <p><opt>-k | --kill</opt></p>
194                <optdesc><p>
195                        Kill a running daemon (Specify -i to select the daemon instance to kill)
196                  </p></optdesc>
197          </option>
198
199          <option>
200                <p><opt>-c | --check-running</opt></p>
201                <optdesc><p>
202                        Check if a daemon is running for a given network interface. Sets the return value to 0 if a daemon is already running or to 255 if not.
203                  </p></optdesc>
204          </option>
205         
206          <option>
207                <p><opt>-v | --version</opt></p>
208                <optdesc><p>
209                        Show version
210                  </p></optdesc>
211          </option>
212         
213          <option>
214                <p><opt>-S | --supend</opt></p> <optdesc><p> Suspend a running
215                daemon. The daemon will no longer check the link status until
216                it is resumed (-R) again. (Specify -i to select the daemon instance
217                to suspend.)  </p></optdesc>
218          </option>
219
220          <option>
221                <p><opt>-R | --resume</opt></p> <optdesc><p> Resume a suspended
222                daemon. (Specify -i to select the daemon instance
223                to resume.)  </p></optdesc>
224          </option>
225
226          <option>
227                <p><opt>-z | --info</opt></p> <optdesc><p>Request that a
228                running daemon shall write its status information to
229                syslog. (Specify -i to select the daemon instance to send the
230                request to.)  </p></optdesc>
231          </option>
232
233        </options>
234       
235        <section name="Files">
236         
237          <p><file>@sysconfdir@/ifplugd/ifplugd.conf</file>: this file is sourced
238                by the init script <file>@sysconfdir@/init.d/ifplugd</file> and
239                contains the interface to be monitored and the options to be
240                used.</p>
241         
242          <p><file>@sysconfdir@/ifplugd/ifplugd.action</file>: this is the script
243                which will be called by the daemon whenever the state of the
244                interface changes. It takes two areguments: the first is the interface
245                name (eg. eth0), the second either "up" or "down". </p>
246               
247          <p><file>/var/run/ifplugd.&lt;iface&gt;.pid</file>: the pid file
248          for ifplugd.</p>
249         
250        </section>
251       
252        <section name="Environment">
253          <p>The action script will be called with two environment variables set:</p>
254
255          <p><arg>IFPLUGD_PREVIOUS</arg> The previous link status. Either
256          "up", "down", "error" or "disabled". The former values should be
257          obvious, the latter is set on daemon startup.</p>
258
259          <p><arg>IFPLUGD_CURRENT</arg> The current link status. See above
260          for possible values.</p>
261
262        </section>
263
264    <section name="Signals">
265      <p><arg>SIGINT, SIGTERM</arg> ifplugd will quit, possibly running the shutdown script. This is issued by passing -k to ifplugd.</p>
266      <p><arg>SIGQUIT</arg> ifplugd will quit, the shutdown script is never run.</p>
267      <p><arg>SIGHUP</arg> ifplugd will write its status information to syslog. This is issued by -z.</p>
268      <p><arg>SIGUSR1</arg> ifplugd will go to suspend mode. (-S)</p>
269      <p><arg>SIGUSR2</arg> ifplugd will resume from suspend mode. (-R)</p>
270    </section>
271
272        <section name="Author">
273          <p>ifplugd was written by Lennart Poettering
274                &lt;@PACKAGE_BUGREPORT@&gt;. ifplugd is available
275                at <url
276                href="@PACKAGE_URL@"/>
277          </p>
278        </section>
279       
280        <section name="See also">
281          <p>
282                <manref name="ifplugd.conf" section="5"/>, <manref name="ifup" section="8"/>, <manref name="interfaces"
283                  section="5"/>, <manref name="ifconfig" section="8"/>, <manref name="ifplugstatus" section="8"/>
284          </p>
285        </section>
286       
287        <section name="Comments">
288          <p>This man page was written using <manref name="xmltoman" section="1"
289                  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
290        </section>
291       
292  </manpage>
Note: See TracBrowser for help on using the repository browser.