From: Lennart Poettering <lennart@poettering.net>
Date: Sat, 2 Sep 2006 13:48:59 +0000 (+0000)
Subject: lots of documentation cleanups and fixes
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=b881d65f485b6ff7d883a87a980bf2c9a5cce4bb;p=catta

lots of documentation cleanups and fixes


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

diff --git a/man/avahi-bookmarks.1.xml.in b/man/avahi-bookmarks.1.xml.in
index 25661f6..9bebd76 100644
--- a/man/avahi-bookmarks.1.xml.in
+++ b/man/avahi-bookmarks.1.xml.in
@@ -83,7 +83,7 @@
     </options>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in
index 306152d..07b7557 100644
--- a/man/avahi-browse.1.xml.in
+++ b/man/avahi-browse.1.xml.in
@@ -108,7 +108,7 @@
 	</options>
 	
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in
index b4ad07d..e9732d6 100644
--- a/man/avahi-daemon.8.xml.in
+++ b/man/avahi-daemon.8.xml.in
@@ -42,8 +42,8 @@
       exclusively by avahi-dnsconfd (a daemon which configures unicast
       DNS servers using server info published via mDNS) and nss-mdns
       (a libc NSS plugin, providing name resolution via mDNS). Finally
-      there is the DBUS interface which provides a rich object
-      oriented interface to DBUS enabled applications.</p>
+      there is the D-Bus interface which provides a rich object
+      oriented interface to D-Bus enabled applications.</p>
       
       <p>Upon startup avahi-daemon interprets its configuration file
       <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML
@@ -63,17 +63,17 @@
 
 	  <option>
 		<p><opt>-D | --daemonize</opt></p>
-		<optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt></p></optdesc>
+		<optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt>.</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>
+        <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt>.</p></optdesc>
       </option>
 
       <option>
         <p><opt>--debug</opt></p>
-        <optdesc><p>Increase verbosity to debug level</p></optdesc>
+        <optdesc><p>Increase verbosity to debug level.</p></optdesc>
       </option>
 
       <option>
@@ -92,10 +92,10 @@
       </option>
 
       <option>
-        <p><opt>--no-proctitle</opt></p>
+        <p><opt>--no-proc-title</opt></p>
         <optdesc><p>Don't change the process name while
-        running. Unless this option is specified avahi will reflect
-        it's current state and selected host name in the process
+        running. Unless this option is specified avahi-daemon will reflect
+        it's current state and the selected host name in the process
         title.</p></optdesc>
       </option>
 
@@ -144,15 +144,15 @@
     </section>
 
     <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>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-daemon will shutdown. (Same as <opt>--kill</opt>).</p>
       <p><arg>SIGHUP</arg>: avahi-daemon will reload unicast DNS
       server data from <file>/etc/resolv.conf</file> and static
-      service definitions from <file>@servicedir@/</file>.</p>
+      service definitions from <file>@servicedir@/</file>. (Same as <opt>--reload</opt>)</p>
       <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p>
     </section>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-daemon.conf.5.xml.in b/man/avahi-daemon.conf.5.xml.in
index 7dff097..bfbd0e5 100644
--- a/man/avahi-daemon.conf.5.xml.in
+++ b/man/avahi-daemon.conf.5.xml.in
@@ -96,12 +96,12 @@
 
       <option>
         <p><opt>enable-dbus=</opt> Takes either "yes", "no" or
-        "warn". If set to "yes" avahi-daemon connects to D-BUS,
+        "warn". If set to "yes" avahi-daemon connects to D-Bus,
         offering an object oriented client API. It is only available
         if Avahi has been compiled with <opt>--enable-dbus</opt> in
         which case it defaults to "yes". "warn" behaves like "yes",
         but the daemon starts up even when it fails to connect to a
-        D-BUS daemon. In addition, if the connection to the D-BUS
+        D-Bus daemon. In addition, if the connection to the D-Bus
         daemon is terminated we try to reconnect. (Unless we are in a
         chroot() environment where this definitely will fail.) </p>
       </option>
@@ -281,13 +281,13 @@
       </option>
 
       <option>
-        <p><opt>rlimit-nproc=</opt> Value for RLIMIT_NPROC (number of process of user). Since only a single avahi-daemon process is usually running you can set this safely to 1.</p>
+        <p><opt>rlimit-nproc=</opt> Value for RLIMIT_NPROC (number of process of user). avahi-daemon forks of a helper process on systems where <manref name="chroot" section="2"/> is available. Therefore this value should not be set below 2.</p>
       </option>
 
     </section>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-discover.1.xml.in b/man/avahi-discover.1.xml.in
index 43574f6..5d4f878 100644
--- a/man/avahi-discover.1.xml.in
+++ b/man/avahi-discover.1.xml.in
@@ -43,7 +43,7 @@
     </options>
 	
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-dnsconfd.8.xml.in b/man/avahi-dnsconfd.8.xml.in
index 14a9f4a..454afac 100644
--- a/man/avahi-dnsconfd.8.xml.in
+++ b/man/avahi-dnsconfd.8.xml.in
@@ -76,7 +76,7 @@
 
     <section name="Files">
       
-      <p><file>@pkgsysconfdir@/dnsconfd.action</file>: the script to run when a DNS server is found or removed.</p>
+      <p><file>@pkgsysconfdir@/avahi-dnsconfd.action</file>: the script to run when a DNS server is found or removed.</p>
     
     </section>
 
@@ -86,7 +86,7 @@
     </section>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-dnsconfd.action.8.xml.in b/man/avahi-dnsconfd.action.8.xml.in
index da8b265..6811422 100644
--- a/man/avahi-dnsconfd.action.8.xml.in
+++ b/man/avahi-dnsconfd.action.8.xml.in
@@ -74,7 +74,7 @@
     </section>  
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-publish.1.xml.in b/man/avahi-publish.1.xml.in
index cab5828..c68f60d 100644
--- a/man/avahi-publish.1.xml.in
+++ b/man/avahi-publish.1.xml.in
@@ -104,7 +104,7 @@
 	</options>
 	
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-resolve.1.xml.in b/man/avahi-resolve.1.xml.in
index f3691b9..dbfccc0 100644
--- a/man/avahi-resolve.1.xml.in
+++ b/man/avahi-resolve.1.xml.in
@@ -87,7 +87,7 @@
 	</options>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi-set-host-name.1.xml.in b/man/avahi-set-host-name.1.xml.in
index b2eb7f4..983b81c 100644
--- a/man/avahi-set-host-name.1.xml.in
+++ b/man/avahi-set-host-name.1.xml.in
@@ -57,7 +57,7 @@
 	</options>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi.hosts.5.xml.in b/man/avahi.hosts.5.xml.in
index 5fe2271..5a92547 100644
--- a/man/avahi.hosts.5.xml.in
+++ b/man/avahi.hosts.5.xml.in
@@ -43,7 +43,7 @@
     </description>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>
 	
diff --git a/man/avahi.service.5.xml.in b/man/avahi.service.5.xml.in
index 2514f33..aeaeb05 100644
--- a/man/avahi.service.5.xml.in
+++ b/man/avahi.service.5.xml.in
@@ -105,7 +105,7 @@
 	</section>
 
 	<section name="Authors">
-	  <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+	  <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 	  available from <url href="@PACKAGE_URL@"/></p>
 	</section>