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