]> git.meshlink.io Git - catta/blobdiff - man/avahi-daemon.conf.5.xml.in
Simplify man page generation
[catta] / man / avahi-daemon.conf.5.xml.in
index 89aa38e51971cf47b3b2e698af27641e95cd144f..baa9a21a33500284aa0c65df4d82d2f684368797 100644 (file)
@@ -4,19 +4,19 @@
 
 <!-- $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
        <synopsis>
       <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd>
        </synopsis>
-       
+
     <description>
       <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p>
        </description>
-       
+
        <section name="Section [Server]">
 
       <option>
       </option>
 
       <option>
-        <p><opt>domain-name=</opt> Set the domain name avahi-domain
+        <p><opt>domain-name=</opt> Set the default domain name avahi-daemon
         tries to register its host name and services on the LAN in. If
-        omited defaults to ".local".</p>
+        omitted defaults to ".local".</p>
+      </option>
+
+      <option>
+        <p><opt>browse-domains=</opt> Set a comma separated list of
+        browsing domains (in addition to the default one and those
+        announced inside the default browsing domain). Please note
+        that the user may specify additional browsing domains on the
+        client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
+        of colon separated domains or by adding them to the XDG config
+        file <file>~/.config/avahi/browse-domains</file> (separated by
+        newlines).</p>
+
       </option>
 
       <option>
         sockets. Default is "yes".</p>
       </option>
 
+      <option>
+        <p><opt>allow-interfaces=</opt> Set a comma separated list of
+        allowed network interfaces that should be used by the
+        avahi-daemon.  Other interfaces will be ignored. If set to the
+        empty list all local interfaces except loopback and
+        point-to-point will be used.</p>
+      </option>
+
+      <option>
+        <p><opt>deny-interfaces=</opt> Set a comma separated list of
+        network interfaces that should be ignored by avahi-daemon.
+       Other not specified interfaces will be used, unless
+       <opt>allow-interfaces</opt> is set. This option takes
+       precedence over <opt>deny-interfaces</opt>.</p>
+      </option>
+
       <option>
         <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
         or "no"). If set to "yes", an additional security check is
 
       <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
+        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.</p>
+        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>
+
+      <option>
+        <p><opt>disallow-other-stacks=</opt> Takes a boolean value
+        ("yes" or "no"). If set to "yes" no other process is allowed
+        to bind to UDP port 5353. This effectively impedes other mDNS
+        stacks from running on the host. Use this as a security
+        measure to make sure that only Avahi is responsible for mDNS
+        traffic. Please note that we do not recommend running multiple
+        mDNS stacks on the same host simultaneously. This hampers
+        reliability and is a waste of resources. However, to not annoy
+        people this option defaults to "no".</p>
+      </option>
+
+      <option>
+        <p><opt>allow-point-to-point=</opt> Takes a boolean value
+        ("yes" or "no"). If set to "yes" avahi-daemon will make use of
+        interfaces with the POINTOPOINT flag set. This option defaults
+        to "no" as it might make mDNS unreliable due to usually large
+        latencies with such links and opens a potential security hole
+        by allowing mDNS access from Internet connections. Use with
+        care and YMMV!</p>
+      </option>
+
+       </section>
+
+       <section name="Section [wide-area]">
+      <option>
+        <p><opt>enable-wide-area=</opt> Takes a boolean value
+        ("yes" or "no"). Enable wide-area DNS-SD, aka
+        DNS-SD over unicast DNS. If this is enabled only domains
+        ending in .local will be resolved on mDNS, all other domains
+        are resolved via unicast DNS. If you want to maintain multiple
+        different multicast DNS domains even with this option enabled
+        we encourage you to use subdomains of .local, such as
+        "kitchen.local". This option defaults to "yes".</p>
       </option>
 
+    </section>
+
+       <section name="Section [publish]">
+
+      <option><p><opt>disable-publishing=</opt> Takes a boolean value
+      ("yes" or "no"). If set to "yes", no record will be published by
+      Avahi, not even address records for the local host. Avahi will
+      be started in a querying-only mode. Use this is a security
+      measure. This option defaults to "no"</p></option>
+
+      <option><p><opt>disable-user-service-publishing=</opt> Takes a boolean value
+      ("yes" or "no"). If set to "yes", Avahi will still publish
+      address records and suchlike but will not allow user
+      applications to publish services. Use this is a security
+      measure. This option defaults to "no"</p></option>
+
       <option>
         <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
         or "no"). If set to "yes" an implicit TXT entry will be added
         which is chosen randomly on daemon startup. This can be used
         to detect if two services on two different
         interfaces/protocols are actually identical. Defaults to
-        "yes".</p>
+        "no".</p>
       </option>
 
-
-       </section>
-
-       <section name="Section [publish]">
       <option>
         <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
         or "no"). If set to "yes" avahi-daemon will register mDNS
       </option>
 
       <option>
-        <p><opt>publish-dns-servers=</opt> Takes a comma seperated
+        <p><opt>publish-dns-servers=</opt> Takes a comma separated
         list of IP addresses for unicast DNS servers. You can use this
         to announce unicast DNS servers via mDNS. When used in
         conjunction with avahi-dnsconfd on the client
         SIGHUP to have it reload this file. Defaults to "no".</p>
       </option>
 
+      <option>
+        <p><opt>publish-aaaa-on-ipv4=</opt> Takes a boolean value
+        ("yes" or "no"). If set to "yes" avahi-daemon will publish an
+        IPv6 AAAA record via IPv4, i.e. the local IPv6 addresses can be
+        resolved using an IPv4 transport. Only useful when IPv4 is
+        enabled with <opt>use-ipv4=true</opt>. Defaults to "yes".</p>
+      </option>
+
+      <option>
+        <p><opt>publish-a-on-ipv6=</opt> Takes a boolean value
+        ("yes" or "no"). If set to "yes" avahi-daemon will publish an
+        IPv4 A record via IPv6, i.e. the local IPv4 addresses can be
+        resolved using an IPv6 transport. Only useful when IPv6 is
+        enabled with <opt>use-ipv6=true</opt>. Defaults to "no".</p>
+      </option>
+
     </section>
 
        <section name="Section [reflector]">
       </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>
-       
+
        <section name="See also">
          <p>
         <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" 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>