1<?xml version="1.0"?><!--*-nxml-*-->
2<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
4
5<!-- $Id$ -->
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" section="8" desc="IPv4LL network address configuration daemon">
27
28	<synopsis>
29      <cmd>avahi-autoipd [<arg>options</arg>] <arg>interface</arg></cmd>
30      <cmd>avahi-autoipd <opt>--kill</opt> <arg>interface</arg></cmd>
31      <cmd>avahi-autoipd <opt>--refresh</opt> <arg>interface</arg></cmd>
32      <cmd>avahi-autoipd <opt>--check</opt> <arg>interface</arg></cmd>
33	</synopsis>
34	
35    <description>
36      <p>avahi-autoipd implements IPv4LL, "Dynamic Configuration of
37      IPv4 Link-Local Addresses" (IETF RFC3927), a protocol for
38      automatic IP address configuration from the link-local
39      169.254.0.0/16 range without the need for a central server. It
40      is primarily intended to be used in ad-hoc networks which lack a
41      DHCP server.</p>
42
43      <p>IPv4LL is part of the Zeroconf stack.</p>
44
45      <p>avahi-autoipd can be used as stand-alone address allocator
46      or as plugin for a DHCP client such as ISC's dhclient, where it
47      can be used as fallback solution if no DHCP server is found.</p>
48
49      <p>To allow communication between hosts that have only an IPv4LL
50      address assigned and hosts that only have a routable IP address
51      assigned you may add the following routes to both network
52      configurations:</p>
53
54      <p><opt>route add -net 169.254.0.0 netmask 255.255.0.0 dev eth0 metric 99</opt></p>
55      <p><opt>route add default dev eth0 metric 99</opt></p>
56
57      <p>See http://developer.apple.com/qa/qa2004/qa1357.html for more information.</p>
58	</description>
59	
60	<options>
61
62	  <option>
63		<p><opt>-D | --daemonize</opt></p>
64		<optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt>.</p></optdesc>
65	  </option>
66
67	  <option>
68		<p><opt>-k | --kill</opt></p>
69		<optdesc><p>Kill an already running avahi-autoipd on the specified network interface. (Equivalent to sending a SIGTERM)</p></optdesc>
70	  </option>
71
72	  <option>
73		<p><opt>-r | --refresh</opt></p>
74		<optdesc><p>Tell an already running avahi-autoipd to reannounce the acquired IP address on the specified network interface. (Equivalent to sending a SIGHUP)</p></optdesc>
75	  </option>
76
77	  <option>
78		<p><opt>-c | --check</opt></p>
79		<optdesc><p>Return 0 as return code if avahi-autoipd is already running for the specified network interface.</p></optdesc>
80	  </option>
81
82      <option>
83        <p><opt>-s | --syslog</opt></p>
84        <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt>.</p></optdesc>
85      </option>
86
87      <option>
88        <p><opt>--debug</opt></p>
89        <optdesc><p>Enable verbose mode.</p></optdesc>
90      </option>
91
92      <option>
93        <p><opt>--no-drop-root</opt></p>
94        <optdesc><p>Don't drop root priviliges after startup. We recommend not to use this option.</p></optdesc>
95      </option>
96
97      <option>
98        <p><opt>--no-chroot</opt></p>
99        <optdesc><p>Don't <manref section="2" name="chroot"/> the daemon. This option is only available when compiled with chroot() support.</p></optdesc>
100      </option>
101
102      <option>
103        <p><opt>-S | --start=</opt></p>
104        <optdesc><p>Try to acquire the specified IP address, which must be from the IPv4LL range 169.254.0.0/16.</p></optdesc>
105      </option>
106
107      <option>
108        <p><opt>-w | --wait</opt></p>
109        <optdesc><p>Wait until a IP address has been sucessfully acquired before detaching. Only valid in combination with <opt>--daemonize</opt>.</p></optdesc>
110      </option>
111      
112      <option>
113        <p><opt>--force-bind</opt></p>
114        <optdesc><p>Acquire an IPv4LL address, even if a routable address has been configured on the interface.</p></optdesc>
115      </option>
116
117      <option>
118        <p><opt>--no-proc-title</opt></p>
119        <optdesc><p>Don't change the process name while
120        running. Unless this option is specified avahi-autoipd will
121        reflect its current state and the IP address in the process
122        title.</p></optdesc>
123      </option>
124
125	  <option>
126		<p><opt>-h | --help</opt></p>
127		<optdesc><p>Show help.</p></optdesc>
128	  </option>
129
130	  <option>
131		<p><opt>-v | --version</opt></p>
132		<optdesc><p>Show version information.</p></optdesc>
133	  </option>
134
135	</options>
136
137    <section name="Files">
138      
139      <p><file>@pkgsysconfdir@/avahi-autoipd.action</file>: the script to run when an IP address as been acquired or is lost.</p>
140    
141    </section>
142
143    <section name="Signals">
144      <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-autoipd will shutdown. (Same as <opt>--kill</opt>)</p>
145      <p><arg>SIGHUP</arg>: avahi-autoipd will reannounce the acquired IP address. (Same as <opt>--refresh</opt>)</p>
146    </section>
147
148	<section name="Authors">
149	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
150	  available from <url href="@PACKAGE_URL@"/></p>
151	</section>
152	
153	<section name="See also">
154	  <p>
155        <manref name="autoipd.action" section="8"/>, <manref name="dhclient" section="8"/>
156	  </p>
157
158      <p>http://avahi.org/wiki/AvahiAutoipd documents how avahi-autoipd is best packaged and integrated into distributions.</p>
159	</section>
160	
161	<section name="Comments">
162	  <p>This man page was written using <manref name="xml2man" section="1"
163		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
164	</section>
165	
166  </manpage>
167