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