]> git.meshlink.io Git - catta/blob - man/avahi-daemon.8.xml.in
Complete AVAHI_LOOKUP_NO_ADDRESS fix
[catta] / man / avahi-daemon.8.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" section="8" desc="The Avahi mDNS/DNS-SD daemon">
27
28         <synopsis>
29       <cmd>avahi-daemon [<arg>options</arg>]</cmd>
30       <cmd>avahi-daemon <opt>--kill</opt></cmd>
31       <cmd>avahi-daemon <opt>--reload</opt></cmd>
32       <cmd>avahi-daemon <opt>--check</opt></cmd>
33       <cmd>avahi-daemon <opt>--version</opt></cmd>
34       <cmd>avahi-daemon <opt>--help</opt></cmd>
35         </synopsis>
36         
37     <description>
38       <p>The Avahi mDNS/DNS-SD daemon implementing Apple's ZeroConf
39       architecture (also known as "Rendezvous" or "Bonjour"). The daemon
40       registers local IP addresses and static services using
41       mDNS/DNS-SD and provides two IPC APIs for local programs to make
42       use of the mDNS record cache the avahi-daemon maintains. First
43       there is the so called "simple protocol" which is used
44       exclusively by avahi-dnsconfd (a daemon which configures unicast
45       DNS servers using server info published via mDNS) and nss-mdns
46       (a libc NSS plugin, providing name resolution via mDNS). Finally
47       there is the DBUS interface which provides a rich object
48       oriented interface to DBUS enabled applications.</p>
49       
50       <p>Upon startup avahi-daemon interprets its configuration file
51       <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML
52       fragments from <file>@servicedir@/*.service</file> which may
53       define static DNS-SD services. If you enable
54       <opt>publish-resolv-conf-dns-servers</opt> in
55       <file>avahi-daemon.conf</file> the file
56       <file>/etc/resolv.conf</file> will be read, too.</p>
57         </description>
58         
59         <options>
60
61           <option>
62                 <p><opt>-f | --file=</opt> <arg>FILE</arg></p>
63                 <optdesc><p>Specify the configuration file to read. (default: @pkgsysconfdir@/avahi-daemon.conf)</p></optdesc>
64           </option>
65
66           <option>
67                 <p><opt>-D | --daemonize</opt></p>
68                 <optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt></p></optdesc>
69           </option>
70
71       <option>
72         <p><opt>-s | --syslog</opt></p>
73         <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt></p></optdesc>
74       </option>
75
76       <option>
77         <p><opt>--debug</opt></p>
78         <optdesc><p>Increase verbosity to debug level</p></optdesc>
79       </option>
80
81       <option>
82         <p><opt>--no-rlimits</opt></p>
83         <optdesc><p>Don't enforce resource limits as specified in the configuration file. (See <manref section="2" name="setrlimit"/> for more information)</p></optdesc>
84       </option>
85
86       <option>
87         <p><opt>--no-drop-root</opt></p>
88         <optdesc><p>Don't drop root priviliges after startup and don't require daemon to be started as root. We recommend not to use this option.</p></optdesc>
89       </option>
90
91           <option>
92                 <p><opt>-k | --kill</opt></p>
93                 <optdesc><p>Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)</p></optdesc>
94           </option>
95
96           <option>
97                 <p><opt>-r | --reload</opt></p>
98                 <optdesc><p>Tell an already running avahi-daemon to reread
99                 <file>/etc/resolv.conf</file> (in case you enabled
100         <opt>publish-resolv-conf-dns-servers</opt> in
101                 <file>avahi-daemon.conf</file>) the files from
102                 <file>@servicedir@/</file>. Please note that this will not
103                 reload the
104                 <file>@pkgsysconfdir@/avahi-daemon.conf</file>(equivalent to
105                 sending a SIGHUP)</p></optdesc>
106           </option>
107
108           <option>
109                 <p><opt>-c | --check</opt></p>
110                 <optdesc><p>Return 0 as return code when avahi-daemon is already running.</p></optdesc>
111           </option>
112
113           <option>
114                 <p><opt>-h | --help</opt></p>
115                 <optdesc><p>Show help</p></optdesc>
116           </option>
117
118           <option>
119                 <p><opt>-v | --version</opt></p>
120                 <optdesc><p>Show version information </p></optdesc>
121           </option>
122
123
124         </options>
125
126
127     <section name="Files">
128       
129       <p><file>@pkgsysconfdir@/avahi-daemon.conf</file>: the default configuration file for avahi-daemon.</p>
130
131       <p><file>@servicedir@/*.service</file>: static service definitions.</p>
132     
133     </section>
134
135     <section name="Signals">
136       <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-daemon will shutdown. This is issued by passing --kill to avahi-daemon.</p>
137       <p><arg>SIGHUP</arg>: avahi-daemon will reload unicast DNS
138       server data from <file>/etc/resolv.conf</file> and static
139       service definitions from <file>@servicedir@/</file>.</p>
140       <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p>
141     </section>
142
143         <section name="Authors">
144           <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
145           available from <url href="@PACKAGE_URL@"/></p>
146         </section>
147         
148         <section name="See also">
149           <p>
150         <manref name="avahi-daemon.conf" section="5"/>, <manref name="avahi.service" section="5"/>, <manref name="avahi-dnsconfd" section="8"/>
151           </p>
152         </section>
153         
154         <section name="Comments">
155           <p>This man page was written using <manref name="xml2man" section="1"
156                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
157         </section>
158         
159   </manpage>