From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 14 Feb 2006 22:13:30 +0000 (+0000)
Subject: add man page for /etc/avahi/hosts and modify other man pages to refer to it
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=668eb7b3e832082dbf80a5e77a84de140c3cd571;p=catta

add man page for /etc/avahi/hosts and modify other man pages to refer to it


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

diff --git a/man/Makefile.am b/man/Makefile.am
index f16e8e1..3b90835 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -27,7 +27,8 @@ man_MANS = \
 	avahi-dnsconfd.8 \
 	avahi-daemon.conf.5 \
 	avahi-dnsconfd.action.8 \
-	avahi.service.5
+	avahi.service.5 \
+	avahi.hosts.5
 
 noinst_DATA = \
 	avahi-browse.1.xml \
@@ -39,7 +40,8 @@ noinst_DATA = \
 	avahi-dnsconfd.8.xml \
 	avahi-daemon.conf.5.xml \
 	avahi-dnsconfd.action.8.xml \
-	avahi.service.5.xml
+	avahi.service.5.xml \
+	avahi.hosts.5.xml
 
 CLEANFILES = \
 	$(noinst_DATA)
@@ -105,6 +107,10 @@ avahi.service.5.xml: avahi.service.5.xml.in Makefile
 		-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+avahi.hosts.5.xml: avahi.hosts.5.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
 
@@ -140,6 +146,8 @@ avahi-dnsconfd.action.8: avahi-dnsconfd.action.8.xml Makefile
 avahi.service.5: avahi.service.5.xml Makefile
 	xmltoman $< > $@
 
+avahi.hosts.5: avahi.hosts.5.xml Makefile
+	xmltoman $< > $@
 
 xmllint: $(noinst_DATA)
 	for f in $(noinst_DATA) ; do \
@@ -162,6 +170,7 @@ EXTRA_DIST = \
 	avahi-daemon.conf.5.xml.in \
 	avahi-dnsconfd.action.8.xml.in \
 	avahi.service.5.xml.in \
+	avahi.hosts.5.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in
index 1c949be..7d01a4b 100644
--- a/man/avahi-daemon.8.xml.in
+++ b/man/avahi-daemon.8.xml.in
@@ -135,9 +135,11 @@
 
     <section name="Files">
       
-      <p><file>@pkgsysconfdir@/avahi-daemon.conf</file>: the default configuration file for avahi-daemon.</p>
+      <p><file>@pkgsysconfdir@/avahi-daemon.conf</file>: the default configuration file for avahi-daemon, <manref name="avahi-daemon.conf" section="5"/> for more information.</p>
 
-      <p><file>@servicedir@/*.service</file>: static service definitions.</p>
+      <p><file>@pkgsysconfdir@/hosts</file>: additional static hostname mappings to publish in mDNS, see <manref name="avahi.hosts" section="5"/> for more information.</p>
+
+      <p><file>@servicedir@/*.service</file>: static service definitions, see <manref name="avahi.service" section="5"/> for more information.</p>
     
     </section>
 
@@ -156,7 +158,7 @@
 	
 	<section name="See also">
 	  <p>
-        <manref name="avahi-daemon.conf" section="5"/>, <manref name="avahi.service" section="5"/>, <manref name="avahi-dnsconfd" section="8"/>
+        <manref name="avahi-daemon.conf" section="5"/>, <manref name="avahi.hosts" section="5"/>, <manref name="avahi.service" section="5"/>, <manref name="avahi-dnsconfd" section="8"/>
 	  </p>
 	</section>
 	
diff --git a/man/avahi.hosts.5.xml.in b/man/avahi.hosts.5.xml.in
new file mode 100644
index 0000000..5fe2271
--- /dev/null
+++ b/man/avahi.hosts.5.xml.in
@@ -0,0 +1,62 @@
+<?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.hosts" section="5" desc="avahi-daemon static host name file">
+
+	<synopsis>
+      <cmd>@pkgsysconfdir@/hosts</cmd>
+	</synopsis>
+	
+    <description>
+      <p><file>@pkgsysconfdir@/hosts</file> is a file which may be used
+      to define static host name to IP address mappings for multicast
+      DNS. This is especially useful when publishing DNS-SD services
+      on behalf of other hosts. See <manref name="avahi.service"
+      section="5"/> for more information.</p>
+
+      <p>The file format is similar to the one of
+      <file>/etc/hosts</file>: on each line an IP address and the
+      corresponding host name. The host names should be in FQDN form,
+      i.e. with appended .local suffix.</p>
+    </description>
+
+	<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-daemon" section="8"/>, <manref name="avahi.service" section="5"/>
+	  </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.service.5.xml.in b/man/avahi.service.5.xml.in
index a5fc82a..2514f33 100644
--- a/man/avahi.service.5.xml.in
+++ b/man/avahi.service.5.xml.in
@@ -83,11 +83,14 @@
 
       <option>
         <p><opt>&lt;host-name&gt;</opt> The host name of the host that
-        provides this service. This should be a host that is resolvable
-        by multicast or unicast DNS. Please note that you need to
-        specify a fully-qualified domain name (FQDN) here, i.e. .local
-        is not appended implicitly! The host name doesn't need to be part of the
-        domain specified in <opt>&lt;domain-name&gt;</opt>.</p>
+        provides this service. This should be a host that is
+        resolvable by multicast or unicast DNS. Please note that you
+        need to specify a fully-qualified domain name (FQDN) here,
+        i.e. .local is not appended implicitly! The host name doesn't
+        need to be part of the domain specified in
+        <opt>&lt;domain-name&gt;</opt>. See <manref name="avahi.hosts"
+        section="5"/> for more information how to publish additional
+        host name mappings.</p>
       </option>
 
       <option>
@@ -108,7 +111,7 @@
 	
 	<section name="See also">
 	  <p>
-        <manref name="avahi-daemon" section="8"/>
+        <manref name="avahi-daemon" section="8"/>, <manref name="avahi.hosts" section="5"/>
 	  </p>
 	</section>