From d66b47f2d2d6dfcf40faad7d4c94d46ac405ebf0 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 7 Aug 2005 19:53:39 +0000
Subject: * add man page for avahi-dnsconfd.action * fix xmltoman DTD

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@263 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
 man/Makefile.am                    | 20 ++++++++-
 man/avahi-dnsconfd.action.8.xml.in | 92 ++++++++++++++++++++++++++++++++++++++
 man/xmltoman.dtd                   |  2 +-
 3 files changed, 111 insertions(+), 3 deletions(-)
 create mode 100644 man/avahi-dnsconfd.action.8.xml.in

(limited to 'man')

diff --git a/man/Makefile.am b/man/Makefile.am
index 4037bee..f9d226a 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -23,7 +23,8 @@ servicedir=$(pkgsysconfdir)/services
 man_MANS = \
 	avahi-daemon.8 \
 	avahi-dnsconfd.8 \
-	avahi-daemon.conf.5 
+	avahi-daemon.conf.5 \
+	avahi-dnsconfd.action.8
 
 if HAVE_PYTHON
 
@@ -48,7 +49,8 @@ noinst_DATA = \
 	avahi-discover.1.xml \
 	avahi-bookmarks.1.xml \
 	avahi-dnsconfd.8.xml \
-	avahi-daemon.conf.5.xml 
+	avahi-daemon.conf.5.xml \
+	avahi-dnsconfd.action.8.xml
 
 EXTRA_DIST = \
 	$(man_MANS) \
@@ -62,6 +64,7 @@ EXTRA_DIST = \
 	avahi-bookmarks.1.xml.in \
 	avahi-dnsconfd.8.xml.in \
 	avahi-daemon.conf.5.xml.in \
+	avahi-dnsconfd.action.8.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
@@ -113,6 +116,11 @@ avahi-daemon.conf.5.xml: avahi-daemon.conf.5.xml.in Makefile
 		-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+avahi-dnsconfd.action.8.xml: avahi-dnsconfd.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' $< > $@
+
 
 if USE_XMLTOMAN
 
@@ -148,4 +156,12 @@ avahi-dnsconfd.8: avahi-dnsconfd.8.xml Makefile
 avahi-daemon.conf.5: avahi-daemon.conf.5.xml Makefile
 	xmltoman $< > $@
 
+avahi-dnsconfd.action.8: avahi-dnsconfd.action.8.xml Makefile
+	xmltoman $< > $@
+
+xmllint: $(noinst_DATA)
+	for f in $(noinst_DATA) ; do \
+			xmllint --noout --valid "$$f" || exit 1 ; \
+	done
+
 endif
diff --git a/man/avahi-dnsconfd.action.8.xml.in b/man/avahi-dnsconfd.action.8.xml.in
new file mode 100644
index 0000000..da8b265
--- /dev/null
+++ b/man/avahi-dnsconfd.action.8.xml.in
@@ -0,0 +1,92 @@
+<?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-dnsconfd.action" section="8" desc="avahi-dnsconfd action script">
+
+	<synopsis>
+      <cmd>@pkgsysconfdir@/avahi-dnsconfd.action</cmd>
+	</synopsis>
+	
+    <description>
+      <p><file>avahi-dnsconfd.action</file> is the action script that
+      is called whenever a new unicast DNS server is found or
+       removed by avahi-dnsconfd. The default script as shipped
+      with avahi patches <file>/etc/resolv.conf</file> to reflect the
+      changed unicast DNS server configuration.</p>
+	</description>
+	
+	<section name="Parameters">
+
+      <option>
+        <p><opt>argv[1]</opt> Contains the character "+" if the DNS server is new, "-" when it shall be removed from the DNS server list.</p>
+      </option>
+
+      <option>
+        <p><opt>argv[2]</opt> The IP address of the DNS server.</p>
+      </option>
+
+      <option>
+        <p><opt>argv[3]</opt> Numerical network interface number this DNS server was found on.</p>
+      </option>
+
+      <option>
+        <p><opt>argv[4]</opt> Numerical protocol number this DNS server was found on. (usually 2 for IPv4 and 10 for IPv6) </p>
+      </option>
+
+	</section>
+
+	<section name="Environment">
+      <option>
+        <p><opt>AVAHI_INTERFACE</opt> Contains the textual interface name the corresponds with argv[3]. (e.g. "eth0")</p>
+      </option>
+      
+      <option><p><opt>AVAHI_INTERFACE_DNS_SERVERS</opt> Contains a
+      list of all DNS servers that avahi-dnsconfd found on the
+      interface <opt>$AVAHI_INTERFACE</opt>, separated by
+      spaces.</p></option>
+
+      <option><p><opt>AVAHI_DNS_SERVERS</opt> Contains a list of all
+      DNS server that avahi-dnsconfd found on all interfaces,
+      separated by spaces.</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-dnsconfd" section="8"/>, <manref name="avahi-daemon" 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/xmltoman.dtd b/man/xmltoman.dtd
index 018e1d8..50158dc 100644
--- a/man/xmltoman.dtd
+++ b/man/xmltoman.dtd
@@ -28,7 +28,7 @@
 <!ATTLIST section name CDATA #REQUIRED>
 <!ELEMENT option (#PCDATA | p | optdesc)*>
 <!ELEMENT optdesc (#PCDATA | p )*>
-<!ELEMENT cmd (#PCDATA | arg)*>
+<!ELEMENT cmd (#PCDATA | arg | opt)*>
 <!ELEMENT options (p | option)*>
 <!ELEMENT seealso (p)*>
 <!ELEMENT opt (#PCDATA)>
-- 
cgit