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 <!--
   6   This file is part of avahi.
   7
   8   avahi is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as
  10   published by the Free Software Foundation; either version 2.1 of the
  11   License, or (at your option) any later version.
  12
  13   avahi is distributed in the hope that it will be useful, but WITHOUT
  14   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16   Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public
  19   License along with avahi; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21   USA.
  22 -->
  23
  24   <manpage name="avahi-daemon" section="8" desc="The Avahi mDNS/DNS-SD daemon">
  25
  26         <synopsis>
  27       <cmd>avahi-daemon [<arg>options</arg>]</cmd>
  28       <cmd>avahi-daemon <opt>--kill</opt></cmd>
  29       <cmd>avahi-daemon <opt>--reload</opt></cmd>
  30       <cmd>avahi-daemon <opt>--check</opt></cmd>
  31         </synopsis>
  32
  33     <description>
  34       <p>The Avahi mDNS/DNS-SD daemon implements Apple's Zeroconf
  35       architecture (also known as "Rendezvous" or "Bonjour"). The daemon
  36       registers local IP addresses and static services using
  37       mDNS/DNS-SD and provides two IPC APIs for local programs to make
  38       use of the mDNS record cache the avahi-daemon maintains. First
  39       there is the so called "simple protocol" which is used
  40       exclusively by avahi-dnsconfd (a daemon which configures unicast
  41       DNS servers using server info published via mDNS) and nss-mdns
  42       (a libc NSS plugin, providing name resolution via mDNS). Finally
  43       there is the D-Bus interface which provides a rich object
  44       oriented interface to D-Bus enabled applications.</p>
  45
  46       <p>Upon startup avahi-daemon interprets its configuration file
  47       <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML
  48       fragments from <file>@servicedir@/*.service</file> which may
  49       define static DNS-SD services. If you enable
  50       <opt>publish-resolv-conf-dns-servers</opt> in
  51       <file>avahi-daemon.conf</file> the file
  52       <file>/etc/resolv.conf</file> will be read, too.</p>
  53         </description>
  54
  55         <options>
  56
  57           <option>
  58                 <p><opt>-f | --file=</opt> <arg>FILE</arg></p>
  59                 <optdesc><p>Specify the configuration file to read. (default: @pkgsysconfdir@/avahi-daemon.conf)</p></optdesc>
  60           </option>
  61
  62           <option>
  63                 <p><opt>-D | --daemonize</opt></p>
  64                 <optdesc><p>Daemonize after startup. Implies <opt>--syslog</opt>.</p></optdesc>
  65           </option>
  66
  67       <option>
  68         <p><opt>-s | --syslog</opt></p>
  69         <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt>.</p></optdesc>
  70       </option>
  71
  72       <option>
  73         <p><opt>--debug</opt></p>
  74         <optdesc><p>Increase verbosity to debug level.</p></optdesc>
  75       </option>
  76
  77       <option>
  78         <p><opt>--no-rlimits</opt></p>
  79         <optdesc><p>Don't enforce resource limits as specified in the configuration file. (See <manref section="2" name="setrlimit"/> for more information)</p></optdesc>
  80       </option>
  81
  82       <option>
  83         <p><opt>--no-drop-root</opt></p>
  84         <optdesc><p>Don't drop root privileges after startup and don't require daemon to be started as root. We recommend not to use this option.</p></optdesc>
  85       </option>
  86
  87       <option>
  88         <p><opt>--no-chroot</opt></p>
  89         <optdesc><p>Don't <manref section="2" name="chroot"/> the daemon. This option is only available when compiled with chroot() support.</p></optdesc>
  90       </option>
  91
  92       <option>
  93         <p><opt>--no-proc-title</opt></p>
  94         <optdesc><p>Don't change the process name while
  95         running. Unless this option is specified avahi-daemon will reflect
  96         its current state and the selected host name in the process
  97         title.</p></optdesc>
  98       </option>
  99
 100           <option>
 101                 <p><opt>-k | --kill</opt></p>
 102                 <optdesc><p>Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)</p></optdesc>
 103           </option>
 104
 105           <option>
 106                 <p><opt>-r | --reload</opt></p>
 107                 <optdesc><p>Tell an already running avahi-daemon to reread
 108                 <file>/etc/resolv.conf</file> (in case you enabled
 109         <opt>publish-resolv-conf-dns-servers</opt> in
 110                 <file>avahi-daemon.conf</file>) the files from
 111                 <file>@servicedir@/</file>. Please note that this will not
 112                 reload the
 113                 <file>@pkgsysconfdir@/avahi-daemon.conf</file>. (equivalent to
 114                 sending a SIGHUP)</p></optdesc>
 115           </option>
 116
 117           <option>
 118                 <p><opt>-c | --check</opt></p>
 119                 <optdesc><p>Return 0 as return code when avahi-daemon is already running.</p></optdesc>
 120           </option>
 121
 122           <option>
 123                 <p><opt>-h | --help</opt></p>
 124                 <optdesc><p>Show help</p></optdesc>
 125           </option>
 126
 127           <option>
 128                 <p><opt>-v | --version</opt></p>
 129                 <optdesc><p>Show version information </p></optdesc>
 130           </option>
 131
 132         </options>
 133
 134     <section name="Files">
 135
 136       <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>
 137
 138       <p><file>@pkgsysconfdir@/hosts</file>: additional static hostname mappings to publish in mDNS, see <manref name="avahi.hosts" section="5"/> for more information.</p>
 139
 140       <p><file>@servicedir@/*.service</file>: static service definitions, see <manref name="avahi.service" section="5"/> for more information.</p>
 141
 142     </section>
 143
 144     <section name="Signals">
 145       <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-daemon will shutdown. (Same as <opt>--kill</opt>).</p>
 146       <p><arg>SIGHUP</arg>: avahi-daemon will reload unicast DNS
 147       server data from <file>/etc/resolv.conf</file> and static
 148       service definitions from <file>@servicedir@/</file>. (Same as <opt>--reload</opt>)</p>
 149       <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p>
 150     </section>
 151
 152         <section name="Authors">
 153           <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 154           available from <url href="@PACKAGE_URL@"/></p>
 155         </section>
 156
 157         <section name="See also">
 158           <p>
 159         <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"/>
 160           </p>
 161
 162       <p>http://avahi.org/wiki/AvahiAndUnicastDotLocal documents the problems when using Avahi in a unicast DNS zone .local.</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>