git.meshlink.io Git - catta/blob - man/avahi-autoipd.action.8.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!-- $Id: avahi-autoipd.action.8.xml.in 263 2005-08-07 19:53:39Z lennart $ -->
   6
   7 <!--
   8   This file is part of avahi.
   9
  10   avahi is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as
  12   published by the Free Software Foundation; either version 2.1 of the
  13   License, or (at your option) any later version.
  14
  15   avahi is distributed in the hope that it will be useful, but WITHOUT
  16   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18   Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public
  21   License along with avahi; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 -->
  25
  26   <manpage name="avahi-autoipd.action" section="8" desc="avahi-autoipd action script">
  27
  28         <synopsis>
  29       <cmd>@pkgsysconfdir@/avahi-autoipd.action</cmd>
  30         </synopsis>
  31
  32     <description>
  33       <p><file>avahi-autoipd.action</file> is the action script that
  34       is called whenever an IP address has been acquired by
  35       avahi-autoipd or when it detected an IP address conflict. The
  36       script should add or remove the specified address from the
  37       specified network interface.</p>
  38         </description>
  39
  40         <section name="Parameters">
  41
  42       <option>
  43         <p><opt>argv[1]</opt> An event string: one of BIND, CONFLICT,
  44         UNBIND or STOP. If BIND is passed an IP address has been
  45         sucessfully acquired and the script shall add it to the
  46         network interface. If CONFLICT is passed avahi-autopid
  47         detected a IP address on the local network, the action script
  48         should remove the configured IP address. If UNBIND is passed
  49         the IP address should be removed from the interface, too,
  50         because a routable address has been configured to the
  51         interface by some other program. If STOP is passed the
  52         avahi-autoipd is being shutdown and the action script should
  53         remove the IP address. In short: on BIND the address should be
  54         added to the interface, on CONFLICT, UNBIND or STOP it should
  55         be removed.
  56         </p>
  57       </option>
  58
  59       <option>
  60         <p><opt>argv[2]</opt> The network interface name.</p>
  61       </option>
  62
  63       <option>
  64         <p><opt>argv[3]</opt> An IP address from the IPv4LL range.</p>
  65       </option>
  66
  67         </section>
  68
  69         <section name="Authors">
  70           <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
  71           available from <url href="@PACKAGE_URL@"/></p>
  72         </section>
  73
  74         <section name="See also">
  75           <p>
  76         <manref name="avahi-autoipd" section="8"/>, <manref name="dhclient-script" section="8"/>, <manref name="ip" section="8"/>, <manref name="ifconfig" section="8"/>
  77           </p>
  78         </section>
  79
  80         <section name="Comments">
  81           <p>This man page was written using <manref name="xml2man" section="1"
  82                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
  83         </section>
  84
  85   </manpage>