From: Lennart Poettering <lennart@poettering.net>
Date: Sat, 2 Sep 2006 13:51:05 +0000 (+0000)
Subject: add avahi autoipd man page
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=40de1a34d5663c55215d56ceaecc1411a6dfd8f8;p=catta

add avahi autoipd man page


git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1310 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---

diff --git a/man/Makefile.am b/man/Makefile.am
index f6bbae0..756d481 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -42,7 +42,9 @@ noinst_DATA = \
 	avahi-daemon.conf.5.xml \
 	avahi-dnsconfd.action.8.xml \
 	avahi.service.5.xml \
-	avahi.hosts.5.xml
+	avahi.hosts.5.xml \
+	avahi-autoipd.8.xml \
+	avahi-autoipd.action.8.xml
 
 CLEANFILES = \
 	$(noinst_DATA)
@@ -62,6 +64,16 @@ man_MANS += \
 endif
 endif
 
+if ENABLE_AUTOIPD
+if HAVE_LIBDAEMON
+
+man_MANS += \
+	avahi-autoipd.8 \
+	avahi-autoipd.action.8
+
+endif
+endif
+
 avahi-browse.1.xml: avahi-browse.1.xml.in Makefile
 	sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
@@ -118,6 +130,17 @@ avahi.hosts.5.xml: avahi.hosts.5.xml.in Makefile
 		-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+avahi-autoipd.action.8.xml: avahi-autoipd.action.8.xml.in Makefile
+	sed	-e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \
+		-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+        -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+avahi-autoipd.8.xml: avahi-autoipd.8.xml.in Makefile
+	sed	-e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \
+		-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+        -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+
 if USE_XMLTOMAN
 
 CLEANFILES += $(man_MANS)
@@ -158,6 +181,12 @@ avahi.service.5: avahi.service.5.xml Makefile
 avahi.hosts.5: avahi.hosts.5.xml Makefile
 	xmltoman $< > $@
 
+avahi-autoipd.action.8: avahi-autoipd.action.8.xml Makefile
+	xmltoman $< > $@
+
+avahi-autoipd.8: avahi-autoipd.8.xml Makefile
+	xmltoman $< > $@
+
 xmllint: $(noinst_DATA)
 	for f in $(noinst_DATA) ; do \
 			xmllint --noout --valid "$$f" || exit 1 ; \
@@ -181,6 +210,8 @@ EXTRA_DIST = \
 	avahi-dnsconfd.action.8.xml.in \
 	avahi.service.5.xml.in \
 	avahi.hosts.5.xml.in \
+	avahi-autoipd.action.8.xml.in \
+	avahi-autoipd.8.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
diff --git a/man/avahi-autoipd.8.xml.in b/man/avahi-autoipd.8.xml.in
new file mode 100644
index 0000000..c40ce39
--- /dev/null
+++ b/man/avahi-autoipd.8.xml.in
@@ -0,0 +1,154 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!-- 
+  This file is part of avahi.
+ 
+  avahi is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as
+  published by the Free Software Foundation; either version 2.1 of the
+  License, or (at your option) any later version.
+ 
+  avahi is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+  Public License for more details.
+ 
+  You should have received a copy of the GNU Lesser General Public
+  License along with avahi; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA.
+-->
+
+  <manpage name="avahi-autoipd" section="8" desc="IPv4LL network address configuration daemon">
+
+	<synopsis>
+      <cmd>avahi-autoipd [<arg>options</arg>] <arg>interface</arg></cmd>
+      <cmd>avahi-autoipd <opt>--kill</opt> <arg>interface</arg></cmd>
+      <cmd>avahi-autoipd <opt>--refresh</opt> <arg>interface</arg></cmd>
+      <cmd>avahi-autoipd <opt>--check</opt> <arg>interface</arg></cmd>
+	</synopsis>
+	
+    <description>
+      <p>avahi-autoipd implements IPv4LL, "Dynamic Configuration of
+      IPv4 Link-Local Addresses" (IETF RFC3927), a protocol for
+      automatic IP address configuration from the link-local
+      169.254.0.0/16 range without the need for a central server. It
+      is primarily intended to be used in ad-hoc networks which lack a
+      DHCP server.</p>
+
+      <p>IPv4LL is part of the Zeroconf stack.</p>
+
+      <p>avahi-autoipd can be used as stand-alone address allocator
+      or as plugin for a DHCP client such as ISC's dhclient, where it
+      can be used as fallback solution if no DHCP server is found.</p>
+	</description>
+	
+	<options>
+
+	  <option>
+		<p><opt>-D | --daemonize</opt></p>
+		<optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt>.</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-k | --kill</opt></p>
+		<optdesc><p>Kill an already running avahi-autoipd on the specified network interface. (Equivalent to sending a SIGTERM)</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-r | --refresh</opt></p>
+		<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>
+	  </option>
+
+	  <option>
+		<p><opt>-c | --check</opt></p>
+		<optdesc><p>Return 0 as return code if avahi-autoipd is already running for the specified network interface.</p></optdesc>
+	  </option>
+
+      <option>
+        <p><opt>-s | --syslog</opt></p>
+        <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt>.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--debug</opt></p>
+        <optdesc><p>Enable verbose mode.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--no-drop-root</opt></p>
+        <optdesc><p>Don't drop root priviliges after startup. We recommend not to use this option.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--no-chroot</opt></p>
+        <optdesc><p>Don't <manref section="2" name="chroot"/> the daemon. This option is only available when compiled with chroot() support.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>-S | --start=</opt></p>
+        <optdesc><p>Try to acquire the specified IP address, which must be from the IPv4LL range 169.254.0.0/16.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>-w | --wait</opt></p>
+        <optdesc><p>Wait until a IP address has been sucessfully acquired before detaching. Only valid in combination with <opt>--daemonize</opt>.</p></optdesc>
+      </option>
+      
+      <option>
+        <p><opt>--force-bind</opt></p>
+        <optdesc><p>Acquire an IPv4LL address, even if a routable address has been configured on the interface.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>--no-proc-title</opt></p>
+        <optdesc><p>Don't change the process name while
+        running. Unless this option is specified avahi-autoipd will
+        reflect it's current state and the IP address in the process
+        title.</p></optdesc>
+      </option>
+
+	  <option>
+		<p><opt>-h | --help</opt></p>
+		<optdesc><p>Show help.</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-v | --version</opt></p>
+		<optdesc><p>Show version information.</p></optdesc>
+	  </option>
+
+	</options>
+
+    <section name="Files">
+      
+      <p><file>@pkgsysconfdir@/avahi-autoipd.action</file>: the script to run when an IP address as been acquired or is lost.</p>
+    
+    </section>
+
+    <section name="Signals">
+      <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-autoipd will shutdown. (Same as <opt>--kill</opt>)</p>
+      <p><arg>SIGHUP</arg>: avahi-autoipd will reannounce the acquired IP address. (Same as <opt>--refresh</opt>)</p>
+    </section>
+
+	<section name="Authors">
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
+	  available from <url href="@PACKAGE_URL@"/></p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+        <manref name="autoipd.action" section="8"/>, <manref name="dhclient" section="8"/>
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xml2man" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>
diff --git a/man/avahi-autoipd.action.8.xml.in b/man/avahi-autoipd.action.8.xml.in
new file mode 100644
index 0000000..1eb6750
--- /dev/null
+++ b/man/avahi-autoipd.action.8.xml.in
@@ -0,0 +1,85 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id: avahi-autoipd.action.8.xml.in 263 2005-08-07 19:53:39Z lennart $ -->
+
+<!-- 
+  This file is part of avahi.
+ 
+  avahi is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as
+  published by the Free Software Foundation; either version 2.1 of the
+  License, or (at your option) any later version.
+ 
+  avahi is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+  Public License for more details.
+ 
+  You should have received a copy of the GNU Lesser General Public
+  License along with avahi; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA.
+-->
+
+  <manpage name="avahi-autoipd.action" section="8" desc="avahi-autoipd action script">
+
+	<synopsis>
+      <cmd>@pkgsysconfdir@/avahi-autoipd.action</cmd>
+	</synopsis>
+	
+    <description>
+      <p><file>avahi-autoipd.action</file> is the action script that
+      is called whenever an IP address has been acquired by
+      avahi-autoipd or when it detected an IP address conflict. The
+      script should add or remove the specified address from the
+      specified network interface.</p>
+	</description>
+	
+	<section name="Parameters">
+
+      <option>
+        <p><opt>argv[1]</opt> An event string: one of BIND, CONFLICT,
+        UNBIND or STOP. If BIND is passed an IP address has been
+        sucessfully acquired and the script shall add it to the
+        network interface. If CONFLICT is passed avahi-autopid
+        detected a IP address on the local network, the action script
+        should remove the configured IP address. If UNBIND is passed
+        the IP address should be removed from the interface, too,
+        because a routable address has been configured to the
+        interface by some other program. If STOP is passed the
+        avahi-autoipd is being shutdown and the action script should
+        remove the IP address. In short: on BIND the address should be
+        added to the interface, on CONFLICT, UNBIND or STOP it should
+        be removed.
+        </p>
+      </option>
+
+      <option>
+        <p><opt>argv[2]</opt> The network interface name.</p>
+      </option>
+
+      <option>
+        <p><opt>argv[3]</opt> An IP address from the IPv4LL range.</p>
+      </option>
+
+	</section>
+
+	<section name="Authors">
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
+	  available from <url href="@PACKAGE_URL@"/></p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+        <manref name="avahi-autoipd" section="8"/>, <manref name="dhclient-script" section="8"/>, <manref name="ip" section="8"/>, <manref name="ifconfig" section="8"/>
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xml2man" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>