git.meshlink.io Git - catta/blob - man/avahi-daemon.conf.5.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8   This file is part of avahi.
   9
  10   avahi is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as
  12   published by the Free Software Foundation; either version 2.1 of the
  13   License, or (at your option) any later version.
  14
  15   avahi is distributed in the hope that it will be useful, but WITHOUT
  16   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18   Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public
  21   License along with avahi; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 -->
  25
  26   <manpage name="avahi-daemon.conf" section="5" desc="avahi-daemon configuration file">
  27
  28         <synopsis>
  29       <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd>
  30         </synopsis>
  31
  32     <description>
  33       <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p>
  34         </description>
  35
  36         <section name="Section [Server]">
  37
  38       <option>
  39         <p><opt>host-name=</opt> Set the host name avahi-daemon tries
  40         to register on the LAN. If omited defaults to the system host
  41         name as set with the sethostname() system call.</p>
  42       </option>
  43
  44       <option>
  45         <p><opt>domain-name=</opt> Set the domain name avahi-domain
  46         tries to register its host name and services on the LAN in. If
  47         omited defaults to ".local".</p>
  48       </option>
  49
  50       <option>
  51         <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or
  52         "no"). If set to "no" avahi-daemon will not use IPv4
  53         sockets. Default is "yes".</p>
  54       </option>
  55
  56       <option>
  57         <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or
  58         "no"). If set to "no" avahi-daemon will not use IPv6
  59         sockets. Default is "yes".</p>
  60       </option>
  61
  62       <option>
  63         <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
  64         or "no"). If set to "yes", an additional security check is
  65         activated: incoming IP packets will be ignored unless the IP
  66         TTL is 255. Earlier mDNS specifications required this
  67         check. Since this feature may be incompatible with newer
  68         implementations of mDNS it defaults to "no". On the other hand
  69         it provides extra security.</p>
  70       </option>
  71
  72       <option>
  73         <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or
  74         "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING
  75         flag bit which is used by some (modern) network drivers to
  76         tell user space if a network cable is plugged in (in case of
  77         copper ethernet), or the network card is associated with some
  78         kind of network (in case of WLAN). If IFF_RUNNING is set
  79         avahi-daemon will automatically announce its services on that
  80         network. Unfortunately far too many network drivers do not
  81         support this flag or support it in a broken way. Therefore
  82         this option defaults to "no".</p>
  83       </option>
  84
  85       <option>
  86         <p><opt>enable-dbus=</opt> Takes a boolean value ("yes" or
  87         "no"). If set to "yes" avahi-daemon connects to DBUS, to offer
  88         an object oriented client API. Only available if avahi has
  89         been compiled with <opt>--enable-dbus</opt> in which case it
  90         defaults to "yes".</p>
  91       </option>
  92
  93         </section>
  94
  95         <section name="Section [publish]">
  96       <option>
  97         <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
  98         or "no"). If set to "yes" avahi-daemon will register mDNS
  99         address records for all local IP addresses. Unless you want to
 100         use avahi-daemon exclusively for browsing it's recommended to
 101         enable this. If you plan to register local services you need
 102         to enable this option. Defaults to "yes".</p>
 103       </option>
 104
 105       <option>
 106         <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
 107         "no"). If set to "yes" avahi-daemon will register an mDNS
 108         HINFO record on all interfaces which contains information
 109         about the local operating system and CPU, which might be
 110         useful for administrative purposes. This is recommended by the
 111         mDNS specification but not required. For the sake of privacy
 112         you might choose to disable this feature. Defaults to
 113         "yes."</p>
 114       </option>
 115
 116       <option>
 117         <p><opt>publish-workstation=</opt> Takes a boolean value
 118         ("yes" or "no"). If set to "yes" avahi-daemon will register a
 119         service of type "_workstation._tcp" on the local LAN. This
 120         might be useful for administrative purposes (i.e. browse for
 121         all PCs on the LAN), but is not required or recommended by any
 122         specification. Newer MacOS X releases register a service of
 123         this type. Defaults to "yes".</p>
 124       </option>
 125
 126       <option>
 127         <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
 128         "no"). If set to "yes" avahi-daemon will announce the locally
 129         used domain name (see above) for browsing by other
 130         hosts. Defaults to "yes".</p>
 131       </option>
 132
 133       <option>
 134         <p><opt>publish-dns-servers=</opt> Takes a comma seperated
 135         list of IP addresses for unicast DNS servers. You can use this
 136         to announce unicast DNS servers via mDNS. When used in
 137         conjunction with avahi-dnsconfd on the client
 138         side this allows DHCP-like configuration of unicast DNS
 139         servers.</p>
 140       </option>
 141
 142       <option>
 143         <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
 144         value ("yes" or "no"). If set to "yes" avahi-daemon will
 145         publish the unicast DNS servers specified in
 146         <file>/etc/resolv.conf</file> in addition to those specified
 147         with <opt>publish-dns-servers</opt>. Send avahi-daemon a
 148         SIGHUP to have it reload this file. Defaults to "no".</p>
 149       </option>
 150
 151     </section>
 152
 153         <section name="Section [reflector]">
 154       <option>
 155         <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
 156         or "no"). If set to "yes" avahi-daemon will reflect incoming
 157         mDNS requests to all local network interfaces, effectively
 158         allowing clients to browse mDNS/DNS-SD services on all
 159         networks connected to the gateway. The gateway is somewhat
 160         intelligent and should work with all kinds of mDNS traffic,
 161         though some functionality is lost (specifically the unicast
 162         reply bit, which is used rarely anyway). Make sure to not run
 163         multiple reflectors between the same networks, this might
 164         cause them to play Ping Pong with mDNS packets. Defaults to
 165         "no".</p>
 166       </option>
 167
 168       <option>
 169         <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
 170         "no"). If set to "yes" and <opt>enable-reflector</opt> is
 171         enabled, avahi-daemon will forward mDNS traffic between IPv4
 172         and IPv6, which is usually not recommended. Defaults to "no".</p>
 173       </option>
 174     </section>
 175
 176     <section name="Section [rlimits]">
 177       <p>This section is used to define system resource limits for the
 178       daemon. See <manref section="2" name="setrlimit"/> for more
 179       information. If any of the options is not specified in the configuration
 180       file, avahi-daemon does not change it from the system
 181       defaults.</p>
 182
 183
 184       <option>
 185         <p><opt>rlimit-as=</opt> Value in bytes for RLIMIT_AS (maximum size of the process's virtual memory). Sensible values are heavily system dependent.</p>
 186       </option>
 187
 188       <option>
 189         <p><opt>rlimit-core=</opt> Value in bytes for RLIMIT_CORE (maximum core file size). Unless you want to debug avahi-daemon, it is safe to set this to 0.</p>
 190       </option>
 191
 192       <option>
 193         <p><opt>rlimit-data=</opt> Value in bytes for RLIMIT_DATA (maximum size of the process's data segment). Sensible values are heavily system dependent.</p>
 194       </option>
 195
 196       <option>
 197         <p><opt>rlimit-fsize=</opt> Value for RLIMIT_FSIZE (maximum size of files the process may create). Since avahi-daemon shouldn't write any files to disk, it is safe to set this to 0.</p>
 198       </option>
 199
 200       <option>
 201         <p><opt>rlimit-nofile=</opt> Value for RLIMIT_NOFILE (open file descriptors). avahi-daemon shouldn't need more than 15 to 20 open file descriptors concurrently.</p>
 202       </option>
 203
 204       <option>
 205         <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
 206       </option>
 207
 208       <option>
 209         <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>
 210       </option>
 211
 212     </section>
 213
 214         <section name="Authors">
 215           <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
 216           available from <url href="@PACKAGE_URL@"/></p>
 217         </section>
 218
 219         <section name="See also">
 220           <p>
 221         <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
 222           </p>
 223         </section>
 224
 225         <section name="Comments">
 226           <p>This man page was written using <manref name="xml2man" section="1"
 227                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
 228         </section>
 229
 230   </manpage>