1 <?xml version="1.0"?><!--*-nxml-*-->
2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
8 This file is part of avahi.
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.
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.
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
26 <manpage name="avahi-daemon.conf" section="5" desc="avahi-daemon configuration file">
29 <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd>
33 <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p>
36 <section name="Section [Server]">
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>
45 <p><opt>domain-name=</opt> Set the default domain name avahi-daemon
46 tries to register its host name and services on the LAN in. If
47 omitted defaults to ".local".</p>
51 <p><opt>browse-domains=</opt> Set a comma seperated list of
52 browsing domains (in addition to the default one and those
53 announced inside the default browsing domain). Please note
54 that the user may specify additional browsing domains on the
55 client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
56 of colon seperated domains or by adding them to the XDG config
57 file <file>~/.config/avahi/browse-domains</file> (seperated by
63 <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or
64 "no"). If set to "no" avahi-daemon will not use IPv4
65 sockets. Default is "yes".</p>
69 <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or
70 "no"). If set to "no" avahi-daemon will not use IPv6
71 sockets. Default is "yes".</p>
75 <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
76 or "no"). If set to "yes", an additional security check is
77 activated: incoming IP packets will be ignored unless the IP
78 TTL is 255. Earlier mDNS specifications required this
79 check. Since this feature may be incompatible with newer
80 implementations of mDNS it defaults to "no". On the other hand
81 it provides extra security.</p>
85 <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or
86 "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING
87 flag bit which is used by some (modern) network drivers to
88 tell user space if a network cable is plugged in (in case of
89 copper ethernet), or the network card is associated with some
90 kind of network (in case of WLAN). If IFF_RUNNING is set
91 avahi-daemon will automatically announce its services on that
92 network. Unfortunately far too many network drivers do not
93 support this flag or support it in a broken way. Therefore
94 this option defaults to "no".</p>
98 <p><opt>enable-dbus=</opt> Takes either "yes", "no" or
99 "warn". If set to "yes" avahi-daemon connects to D-BUS,
100 offering an object oriented client API. It is only available
101 if avahi has been compiled with <opt>--enable-dbus</opt> in
102 which case it defaults to "yes". "warn" behaves like "yes",
103 but the daemon starts up even when it fails to connect to a
108 <p><opt>disallow-other-stacks=</opt> Takes a boolean value
109 ("yes" or "no"). If set to "yes", no other process is allowed
110 to bind to UDP port 5353. This effectively impedes other mDNS
111 stacks from running on the host. Use this as a security
112 measure to make sure that only Avahi is responsible for mDNS
113 traffic. Please note that we do no recommend running multiple
114 mDNS stacks on the same host simultaneously. This hampers
115 reliability and is a waste of resources. However, to not annoy
116 people this option defaults to "no".</p>
121 <section name="Section [wide-area]">
123 <p><opt>enable-wide-area=</opt> Enable wide-area DNS-SD, aka
124 DNS-SD over unicast DNS. If this is enabled only domains
125 ending in .local will be resolved on mDNS, all other domains
126 are resolved via unicast DNS. If you want to maintain multiple
127 different multicast DNS domains even with this option enabled
128 we encourage you to use subdomains of .local, such as
129 "kitchen.local". This option defaults to "yes".</p>
134 <section name="Section [publish]">
136 <option><p><opt>disable-publishing=</opt> Takes a boolean value
137 ("yes" or "no"). If set to "yes", no record will be published by
138 Avahi, not even address records for the local host. Avahi will
139 be started in a querying-only mode. Use this is a security
140 measure. This option defaults to "no"</p></option>
142 <option><p><opt>disable-publishing=</opt> Takes a boolean value
143 ("yes" or "no"). If set to "yes", Avahi will still publish
144 address records and suchlike but will not allow user
145 applications to publish services. Use this is a security
146 measure. This option defaults to "no"</p></option>
149 <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
150 or "no"). If set to "yes" an implicit TXT entry will be added
151 to all locally registered services, containing a cookie value
152 which is chosen randomly on daemon startup. This can be used
153 to detect if two services on two different
154 interfaces/protocols are actually identical. Defaults to
159 <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
160 or "no"). If set to "yes" avahi-daemon will register mDNS
161 address records for all local IP addresses. Unless you want to
162 use avahi-daemon exclusively for browsing it's recommended to
163 enable this. If you plan to register local services you need
164 to enable this option. Defaults to "yes".</p>
168 <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
169 "no"). If set to "yes" avahi-daemon will register an mDNS
170 HINFO record on all interfaces which contains information
171 about the local operating system and CPU, which might be
172 useful for administrative purposes. This is recommended by the
173 mDNS specification but not required. For the sake of privacy
174 you might choose to disable this feature. Defaults to
179 <p><opt>publish-workstation=</opt> Takes a boolean value
180 ("yes" or "no"). If set to "yes" avahi-daemon will register a
181 service of type "_workstation._tcp" on the local LAN. This
182 might be useful for administrative purposes (i.e. browse for
183 all PCs on the LAN), but is not required or recommended by any
184 specification. Newer MacOS X releases register a service of
185 this type. Defaults to "yes".</p>
189 <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
190 "no"). If set to "yes" avahi-daemon will announce the locally
191 used domain name (see above) for browsing by other
192 hosts. Defaults to "yes".</p>
196 <p><opt>publish-dns-servers=</opt> Takes a comma seperated
197 list of IP addresses for unicast DNS servers. You can use this
198 to announce unicast DNS servers via mDNS. When used in
199 conjunction with avahi-dnsconfd on the client
200 side this allows DHCP-like configuration of unicast DNS
205 <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
206 value ("yes" or "no"). If set to "yes" avahi-daemon will
207 publish the unicast DNS servers specified in
208 <file>/etc/resolv.conf</file> in addition to those specified
209 with <opt>publish-dns-servers</opt>. Send avahi-daemon a
210 SIGHUP to have it reload this file. Defaults to "no".</p>
215 <section name="Section [reflector]">
217 <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
218 or "no"). If set to "yes" avahi-daemon will reflect incoming
219 mDNS requests to all local network interfaces, effectively
220 allowing clients to browse mDNS/DNS-SD services on all
221 networks connected to the gateway. The gateway is somewhat
222 intelligent and should work with all kinds of mDNS traffic,
223 though some functionality is lost (specifically the unicast
224 reply bit, which is used rarely anyway). Make sure to not run
225 multiple reflectors between the same networks, this might
226 cause them to play Ping Pong with mDNS packets. Defaults to
231 <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
232 "no"). If set to "yes" and <opt>enable-reflector</opt> is
233 enabled, avahi-daemon will forward mDNS traffic between IPv4
234 and IPv6, which is usually not recommended. Defaults to "no".</p>
238 <section name="Section [rlimits]">
239 <p>This section is used to define system resource limits for the
240 daemon. See <manref section="2" name="setrlimit"/> for more
241 information. If any of the options is not specified in the configuration
242 file, avahi-daemon does not change it from the system
247 <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>
251 <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>
255 <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>
259 <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>
263 <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>
267 <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
271 <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>
276 <section name="Authors">
277 <p>The avahi developers <@PACKAGE_BUGREPORT@>; avahi is
278 available from <url href="@PACKAGE_URL@"/></p>
281 <section name="See also">
283 <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
287 <section name="Comments">
288 <p>This man page was written using <manref name="xml2man" section="1"
289 href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>