]> git.meshlink.io Git - catta/blob - avahi-daemon.conf.5.xml.in
efd1a41a038e3a1c69172e0e6b8ce12e2fa6a927
[catta] / 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 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>
48       </option>
49
50       <option>
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
58         newlines).</p>
59         
60       </option>
61
62       <option>
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>
66       </option>
67
68       <option>
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>
72       </option>
73
74       <option>
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>
82       </option>
83
84       <option>
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>
95       </option>
96
97       <option>
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
104         D-Bus daemon. In addition, if the connection to the D-Bus
105         daemon is terminated we try to reconnect. (Unless we are in a
106         chroot() environment where this definitely will fail.) </p>
107       </option>
108
109       <option>
110         <p><opt>disallow-other-stacks=</opt> Takes a boolean value
111         ("yes" or "no"). If set to "yes" no other process is allowed
112         to bind to UDP port 5353. This effectively impedes other mDNS
113         stacks from running on the host. Use this as a security
114         measure to make sure that only Avahi is responsible for mDNS
115         traffic. Please note that we do no recommend running multiple
116         mDNS stacks on the same host simultaneously. This hampers
117         reliability and is a waste of resources. However, to not annoy
118         people this option defaults to "no".</p>
119       </option>
120
121       <option>
122         <p><opt>allow-point-to-point=</opt> Takes a boolean value
123         ("yes" or "no"). If set to "yes" avahi-daemon will make use of
124         interfaces with the POINTOPOINT flag set. This option defaults
125         to "no" as it might make mDNS unreliable due to usually large
126         latencies with such links and opens a potential security hole
127         by allowing mDNS access from Internet connections. Use with
128         care and YMMV!</p>
129       </option>
130
131         </section>
132
133         <section name="Section [wide-area]">
134       <option>
135         <p><opt>enable-wide-area=</opt> Takes a boolean value
136         ("yes" or "no"). Enable wide-area DNS-SD, aka
137         DNS-SD over unicast DNS. If this is enabled only domains
138         ending in .local will be resolved on mDNS, all other domains
139         are resolved via unicast DNS. If you want to maintain multiple
140         different multicast DNS domains even with this option enabled
141         we encourage you to use subdomains of .local, such as
142         "kitchen.local". This option defaults to "yes".</p>
143       </option>
144       
145     </section>
146
147         <section name="Section [publish]">
148
149       <option><p><opt>disable-publishing=</opt> Takes a boolean value
150       ("yes" or "no"). If set to "yes", no record will be published by
151       Avahi, not even address records for the local host. Avahi will
152       be started in a querying-only mode. Use this is a security
153       measure. This option defaults to "no"</p></option>
154
155       <option><p><opt>disable-user-service-publishing=</opt> Takes a boolean value
156       ("yes" or "no"). If set to "yes", Avahi will still publish
157       address records and suchlike but will not allow user
158       applications to publish services. Use this is a security
159       measure. This option defaults to "no"</p></option>
160
161       <option>
162         <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
163         or "no"). If set to "yes" an implicit TXT entry will be added
164         to all locally registered services, containing a cookie value
165         which is chosen randomly on daemon startup. This can be used
166         to detect if two services on two different
167         interfaces/protocols are actually identical. Defaults to
168         "yes".</p>
169       </option>
170
171       <option>
172         <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
173         or "no"). If set to "yes" avahi-daemon will register mDNS
174         address records for all local IP addresses. Unless you want to
175         use avahi-daemon exclusively for browsing it's recommended to
176         enable this. If you plan to register local services you need
177         to enable this option. Defaults to "yes".</p>
178       </option>
179
180       <option>
181         <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
182         "no"). If set to "yes" avahi-daemon will register an mDNS
183         HINFO record on all interfaces which contains information
184         about the local operating system and CPU, which might be
185         useful for administrative purposes. This is recommended by the
186         mDNS specification but not required. For the sake of privacy
187         you might choose to disable this feature. Defaults to
188         "yes."</p>
189       </option>
190
191       <option>
192         <p><opt>publish-workstation=</opt> Takes a boolean value
193         ("yes" or "no"). If set to "yes" avahi-daemon will register a
194         service of type "_workstation._tcp" on the local LAN. This
195         might be useful for administrative purposes (i.e. browse for
196         all PCs on the LAN), but is not required or recommended by any
197         specification. Newer MacOS X releases register a service of
198         this type. Defaults to "yes".</p>
199       </option>
200
201       <option>
202         <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
203         "no"). If set to "yes" avahi-daemon will announce the locally
204         used domain name (see above) for browsing by other
205         hosts. Defaults to "yes".</p>
206       </option>
207
208       <option>
209         <p><opt>publish-dns-servers=</opt> Takes a comma seperated
210         list of IP addresses for unicast DNS servers. You can use this
211         to announce unicast DNS servers via mDNS. When used in
212         conjunction with avahi-dnsconfd on the client
213         side this allows DHCP-like configuration of unicast DNS
214         servers.</p>
215       </option>
216
217       <option>
218         <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
219         value ("yes" or "no"). If set to "yes" avahi-daemon will
220         publish the unicast DNS servers specified in
221         <file>/etc/resolv.conf</file> in addition to those specified
222         with <opt>publish-dns-servers</opt>. Send avahi-daemon a
223         SIGHUP to have it reload this file. Defaults to "no".</p>
224       </option>
225
226       <option>
227         <p><opt>publish-aaaa-on-ipv4=</opt> Takes a boolean value
228         ("yes" or "no"). If set to "yes" avahi-daemon will publish an
229         IPv6 AAAA record via IPv4, i.e. the local IPv6 addresses can be
230         resolved using an IPv4 transport. Only useful when IPv4 is
231         enabled with <opt>use-ipv4=true</opt>. Defaults to "yes".</p>
232       </option>
233
234       <option>
235         <p><opt>publish-a-on-ipv6=</opt> Takes a boolean value
236         ("yes" or "no"). If set to "yes" avahi-daemon will publish an
237         IPv4 A record via IPv6, i.e. the local IPv4 addresses can be
238         resolved using an IPv6 transport. Only useful when IPv6 is
239         enabled with <opt>use-ipv6=true</opt>. Defaults to "no".</p>
240       </option>
241
242     </section>
243
244         <section name="Section [reflector]">
245       <option>
246         <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
247         or "no"). If set to "yes" avahi-daemon will reflect incoming
248         mDNS requests to all local network interfaces, effectively
249         allowing clients to browse mDNS/DNS-SD services on all
250         networks connected to the gateway. The gateway is somewhat
251         intelligent and should work with all kinds of mDNS traffic,
252         though some functionality is lost (specifically the unicast
253         reply bit, which is used rarely anyway). Make sure to not run
254         multiple reflectors between the same networks, this might
255         cause them to play Ping Pong with mDNS packets. Defaults to
256         "no".</p>
257       </option>
258
259       <option>
260         <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
261         "no"). If set to "yes" and <opt>enable-reflector</opt> is
262         enabled, avahi-daemon will forward mDNS traffic between IPv4
263         and IPv6, which is usually not recommended. Defaults to "no".</p>
264       </option>
265     </section>
266
267     <section name="Section [rlimits]">
268       <p>This section is used to define system resource limits for the
269       daemon. See <manref section="2" name="setrlimit"/> for more
270       information. If any of the options is not specified in the configuration
271       file, avahi-daemon does not change it from the system
272       defaults.</p>
273
274
275       <option>
276         <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>
277       </option>
278
279       <option>
280         <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>
281       </option>
282
283       <option>
284         <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>
285       </option>
286
287       <option>
288         <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>
289       </option>
290
291       <option>
292         <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>
293       </option>
294
295       <option>
296         <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
297       </option>
298
299       <option>
300         <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>
301       </option>
302
303     </section>
304
305         <section name="Authors">
306           <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
307           available from <url href="@PACKAGE_URL@"/></p>
308         </section>
309         
310         <section name="See also">
311           <p>
312         <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
313           </p>
314         </section>
315         
316         <section name="Comments">
317           <p>This man page was written using <manref name="xml2man" section="1"
318                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
319         </section>
320         
321   </manpage>