]> git.meshlink.io Git - catta/blob - man/avahi-daemon.conf.5.xml.in
Complete AVAHI_LOOKUP_NO_ADDRESS fix
[catta] / 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 either "yes", "no" or
87         "warn". If set to "yes" avahi-daemon connects to D-BUS,
88         offering an object oriented client API. It is only available
89         if avahi has been compiled with <opt>--enable-dbus</opt> in
90         which case it defaults to "yes". "warn" behaves like "yes",
91         but the daemon starts up even when it fails to connect to a
92         D-BUS daemon.</p>
93       </option>
94
95       <option>
96         <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
97         or "no"). If set to "yes" an implicit TXT entry will be added
98         to all locally registered services, containing a cookie value
99         which is chosen randomly on daemon startup. This can be used
100         to detect if two services on two different
101         interfaces/protocols are actually identical. Defaults to
102         "yes".</p>
103       </option>
104
105
106         </section>
107
108         <section name="Section [publish]">
109       <option>
110         <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
111         or "no"). If set to "yes" avahi-daemon will register mDNS
112         address records for all local IP addresses. Unless you want to
113         use avahi-daemon exclusively for browsing it's recommended to
114         enable this. If you plan to register local services you need
115         to enable this option. Defaults to "yes".</p>
116       </option>
117
118       <option>
119         <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
120         "no"). If set to "yes" avahi-daemon will register an mDNS
121         HINFO record on all interfaces which contains information
122         about the local operating system and CPU, which might be
123         useful for administrative purposes. This is recommended by the
124         mDNS specification but not required. For the sake of privacy
125         you might choose to disable this feature. Defaults to
126         "yes."</p>
127       </option>
128
129       <option>
130         <p><opt>publish-workstation=</opt> Takes a boolean value
131         ("yes" or "no"). If set to "yes" avahi-daemon will register a
132         service of type "_workstation._tcp" on the local LAN. This
133         might be useful for administrative purposes (i.e. browse for
134         all PCs on the LAN), but is not required or recommended by any
135         specification. Newer MacOS X releases register a service of
136         this type. Defaults to "yes".</p>
137       </option>
138
139       <option>
140         <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
141         "no"). If set to "yes" avahi-daemon will announce the locally
142         used domain name (see above) for browsing by other
143         hosts. Defaults to "yes".</p>
144       </option>
145
146       <option>
147         <p><opt>publish-dns-servers=</opt> Takes a comma seperated
148         list of IP addresses for unicast DNS servers. You can use this
149         to announce unicast DNS servers via mDNS. When used in
150         conjunction with avahi-dnsconfd on the client
151         side this allows DHCP-like configuration of unicast DNS
152         servers.</p>
153       </option>
154
155       <option>
156         <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
157         value ("yes" or "no"). If set to "yes" avahi-daemon will
158         publish the unicast DNS servers specified in
159         <file>/etc/resolv.conf</file> in addition to those specified
160         with <opt>publish-dns-servers</opt>. Send avahi-daemon a
161         SIGHUP to have it reload this file. Defaults to "no".</p>
162       </option>
163
164     </section>
165
166         <section name="Section [reflector]">
167       <option>
168         <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
169         or "no"). If set to "yes" avahi-daemon will reflect incoming
170         mDNS requests to all local network interfaces, effectively
171         allowing clients to browse mDNS/DNS-SD services on all
172         networks connected to the gateway. The gateway is somewhat
173         intelligent and should work with all kinds of mDNS traffic,
174         though some functionality is lost (specifically the unicast
175         reply bit, which is used rarely anyway). Make sure to not run
176         multiple reflectors between the same networks, this might
177         cause them to play Ping Pong with mDNS packets. Defaults to
178         "no".</p>
179       </option>
180
181       <option>
182         <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
183         "no"). If set to "yes" and <opt>enable-reflector</opt> is
184         enabled, avahi-daemon will forward mDNS traffic between IPv4
185         and IPv6, which is usually not recommended. Defaults to "no".</p>
186       </option>
187     </section>
188
189     <section name="Section [rlimits]">
190       <p>This section is used to define system resource limits for the
191       daemon. See <manref section="2" name="setrlimit"/> for more
192       information. If any of the options is not specified in the configuration
193       file, avahi-daemon does not change it from the system
194       defaults.</p>
195
196
197       <option>
198         <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>
199       </option>
200
201       <option>
202         <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>
203       </option>
204
205       <option>
206         <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>
207       </option>
208
209       <option>
210         <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>
211       </option>
212
213       <option>
214         <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>
215       </option>
216
217       <option>
218         <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
219       </option>
220
221       <option>
222         <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>
223       </option>
224
225     </section>
226
227         <section name="Authors">
228           <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
229           available from <url href="@PACKAGE_URL@"/></p>
230         </section>
231         
232         <section name="See also">
233           <p>
234         <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
235           </p>
236         </section>
237         
238         <section name="Comments">
239           <p>This man page was written using <manref name="xml2man" section="1"
240                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
241         </section>
242         
243   </manpage>