From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 7 Aug 2005 12:57:13 +0000 (+0000)
Subject: add dnsconfd man page
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=a9e118b82c39b12695575229934af435058668a5;p=catta

add dnsconfd man page


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

diff --git a/avahi-dnsconfd/main.c b/avahi-dnsconfd/main.c
index 959f177..db807da 100644
--- a/avahi-dnsconfd/main.c
+++ b/avahi-dnsconfd/main.c
@@ -60,7 +60,7 @@ static gboolean quit = FALSE;
 static enum {
     DAEMON_RUN,
     DAEMON_KILL,
-    DAEMON_RELOAD,
+    DAEMON_REFRESH,
     DAEMON_VERSION,
     DAEMON_HELP,
     DAEMON_CHECK
@@ -343,7 +343,7 @@ static void help(FILE *f, const gchar *argv0) {
             "    -h --help        Show this help\n"
             "    -D --daemonize   Daemonize after startup\n"
             "    -k --kill        Kill a running daemon\n"
-            "    -r --reload      Request a running daemon to reload static services\n"
+            "    -r --refresh     Request a running daemon to refresh DNS server data\n"
             "    -c --check       Return 0 if a daemon is already running\n"
             "    -V --version     Show version\n",
             argv0);
@@ -357,7 +357,7 @@ static gint parse_command_line(int argc, char *argv[]) {
         { "daemonize", no_argument,       NULL, 'D' },
         { "kill",      no_argument,       NULL, 'k' },
         { "version",   no_argument,       NULL, 'V' },
-        { "reload",    no_argument,       NULL, 'r' },
+        { "refresh",   no_argument,       NULL, 'r' },
         { "check",     no_argument,       NULL, 'c' },
     };
 
@@ -378,7 +378,7 @@ static gint parse_command_line(int argc, char *argv[]) {
                 command = DAEMON_VERSION;
                 break;
             case 'r':
-                command = DAEMON_RELOAD;
+                command = DAEMON_REFRESH;
                 break;
             case 'c':
                 command = DAEMON_CHECK;
@@ -454,7 +454,7 @@ static int run_daemon(void) {
                     break;
                     
                 case SIGHUP:
-                    daemon_log(LOG_INFO, "Rrefreshing DNS Server list");
+                    daemon_log(LOG_INFO, "Refreshing DNS Server list");
                     
                     close(fd);
                     free_dns_server_info_list();
@@ -597,7 +597,7 @@ gint main(gint argc, gchar *argv[]) {
         }
         
         r = 0;
-    } else if (command == DAEMON_RELOAD) {
+    } else if (command == DAEMON_REFRESH) {
         if (daemon_pid_file_kill(SIGHUP) < 0) {
             daemon_log(LOG_WARNING, "Failed to kill daemon: %s", strerror(errno));
             goto finish;
diff --git a/man/Makefile.am b/man/Makefile.am
index 885f9d8..39ebcd9 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -21,7 +21,8 @@ pkgsysconfdir=$(sysconfdir)/avahi
 servicedir=$(pkgsysconfdir)/services
 
 man_MANS = \
-	avahi-daemon.8
+	avahi-daemon.8 \
+	avahi-dnsconfd.8
 
 if HAVE_PYTHON
 
@@ -44,7 +45,8 @@ noinst_DATA = \
 	avahi-resolve-host-name.1.xml \
 	avahi-daemon.8.xml \
 	avahi-discover.1.xml \
-	avahi-bookmarks.1.xml
+	avahi-bookmarks.1.xml \
+	avahi-dnsconfd.8.xml
 
 EXTRA_DIST = \
 	$(man_MANS) \
@@ -56,6 +58,7 @@ EXTRA_DIST = \
 	avahi-daemon.8.xml.in \
 	avahi-discover.1.xml.in \
 	avahi-bookmarks.1.xml.in \
+	avahi-dnsconfd.8.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
@@ -97,6 +100,12 @@ avahi-bookmarks.1.xml: avahi-bookmarks.1.xml.in Makefile
 	sed	-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+avahi-dnsconfd.8.xml: avahi-dnsconfd.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)
@@ -125,4 +134,7 @@ avahi-discover.1: avahi-discover.1.xml Makefile
 avahi-bookmarks.1: avahi-bookmarks.1.xml Makefile
 	xmltoman $< > $@
 
+avahi-dnsconfd.8: avahi-dnsconfd.8.xml Makefile
+	xmltoman $< > $@
+
 endif
diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in
index 3e461ac..a701340 100644
--- a/man/avahi-daemon.8.xml.in
+++ b/man/avahi-daemon.8.xml.in
@@ -47,9 +47,9 @@
       there is the DBUS interface which provides a rich object
       oriented interface to DBUS enabled applications.</p>
       
-      <p>Upon startup avahi-daemon interpretes its configuration file
-      @pkgsysconfdir@/avahi-daemon.conf and reads XML fragments from
-      @servicedir@/*.service which may define static DNS-SD
+      <p>Upon startup avahi-daemon interprets its configuration file
+      <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML fragments from
+      <file>@servicedir@/*.service</file> which may define static DNS-SD
       services.</p>
 	</description>
 	
@@ -62,7 +62,7 @@
 
 	  <option>
 		<p><opt>-D | --daemonize</opt></p>
-		<optdesc><p>Daemonize avahi-daemon after startup and redirect log messages to syslog.</p></optdesc>
+		<optdesc><p>Daemonize after startup and redirect log messages to syslog.</p></optdesc>
 	  </option>
 
 	  <option>
@@ -72,7 +72,7 @@
 
 	  <option>
 		<p><opt>-r | --reload</opt></p>
-		<optdesc><p>Tell an already running avahi-daemon to reread the files from @servicedir@/. (equivalent to sending a SIGHUP)</p></optdesc>
+		<optdesc><p>Tell an already running avahi-daemon to reread the files from <file>@servicedir@/</file>. Please note that this will not reload the <file>@pkgsysconfdir@/avahi-daemon.conf</file>(equivalent to sending a SIGHUP)</p></optdesc>
 	  </option>
 
 	  <option>
@@ -103,7 +103,7 @@
 
     <section name="Signals">
       <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-daemon will shutdown. This is issued by passing --kill to avahi-daemon.</p>
-      <p><arg>SIGHUP</arg>: avahi-daemon will reload the static service definitions from @servicedir@/.</p>
+      <p><arg>SIGHUP</arg>: avahi-daemon will reload the static service definitions from <file>@servicedir@/</file>.</p>
       <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p>
     </section>
 
diff --git a/man/avahi-dnsconfd.8.xml.in b/man/avahi-dnsconfd.8.xml.in
new file mode 100644
index 0000000..bd99f47
--- /dev/null
+++ b/man/avahi-dnsconfd.8.xml.in
@@ -0,0 +1,107 @@
+<?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" section="8" desc="Unicast DNS server from mDNS/DNS-SD configuration daemon">
+
+	<synopsis>
+      <cmd>avahi-dnsconfd [<arg>options</arg>]</cmd>
+      <cmd>avahi-dnsconfd <opt>--kill</opt></cmd>
+      <cmd>avahi-dnsconfd <opt>--refresh</opt></cmd>
+      <cmd>avahi-dnsconfd <opt>--check</opt></cmd>
+      <cmd>avahi-dnsconfd <opt>--version</opt></cmd>
+      <cmd>avahi-dnsconfd<opt>--help</opt></cmd>
+	</synopsis>
+	
+    <description>
+      <p>avahi-dnsconfd connects to a running avahi-daemon and runs
+      the script <file>@pkgsysconfdir@/dnsconf.action</file> for each unicast DNS
+      server that is announced on the local LAN. This is useful for
+      configuring unicast DNS servers in a DHCP-like fashion with
+      mDNS.</p>
+	</description>
+	
+	<options>
+
+	  <option>
+		<p><opt>-D | --daemonize</opt></p>
+		<optdesc><p>Daemonize after startup and redirect log messages to syslog.</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-k | --kill</opt></p>
+		<optdesc><p>Kill an already running avahi-dnsconfd. (equivalent to sending a SIGTERM)</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-r | --refresh</opt></p>
+		<optdesc><p>Tell an already running avahi-dnsconfd to refresh the DNS server data. (equivalent to sending a SIGHUP)</p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-c | --check</opt></p>
+		<optdesc><p>Return 0 as return code when avahi-dnsconfd is already running.</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@/dnsconf.action</file>: the script to run when a DNS server is found or removed.</p>
+    
+    </section>
+
+    <section name="Signals">
+      <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-dnsconfd will shutdown. This is issued by passing --kill to avahi-daemon.</p>
+      <p><arg>SIGHUP</arg>: avahi-dnsconfd will refresh the DNS server data.</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="avahi-daemon" section="8"/>, <manref name="dnsconf.action" 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>