diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 15 | ||||
-rw-r--r-- | man/avahi-daemon.8.xml.in | 22 | ||||
-rw-r--r-- | man/avahi-daemon.conf.5.xml.in | 192 |
3 files changed, 222 insertions, 7 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 39ebcd9..946a15f 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -22,7 +22,8 @@ servicedir=$(pkgsysconfdir)/services man_MANS = \ avahi-daemon.8 \ - avahi-dnsconfd.8 + avahi-dnsconfd.8 \ + avahi-daemon.conf.5 if HAVE_PYTHON @@ -46,7 +47,8 @@ noinst_DATA = \ avahi-daemon.8.xml \ avahi-discover.1.xml \ avahi-bookmarks.1.xml \ - avahi-dnsconfd.8.xml + avahi-dnsconfd.8.xml \ + avahi-daemon.conf.5.xml EXTRA_DIST = \ $(man_MANS) \ @@ -59,6 +61,7 @@ EXTRA_DIST = \ avahi-discover.1.xml.in \ avahi-bookmarks.1.xml.in \ avahi-dnsconfd.8.xml.in \ + avahi-daemon.5.conf.xml.in \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd @@ -105,6 +108,11 @@ avahi-dnsconfd.8.xml: avahi-dnsconfd.8.xml.in Makefile -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ +avahi-daemon.conf.5.xml: avahi-daemon.conf.5.xml.in Makefile + sed -e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + if USE_XMLTOMAN @@ -137,4 +145,7 @@ avahi-bookmarks.1: avahi-bookmarks.1.xml Makefile avahi-dnsconfd.8: avahi-dnsconfd.8.xml Makefile xmltoman $< > $@ +avahi-daemon.conf.5: avahi-daemon.conf.5.xml Makefile + xmltoman $< > $@ + endif diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in index a701340..87853ec 100644 --- a/man/avahi-daemon.8.xml.in +++ b/man/avahi-daemon.8.xml.in @@ -48,9 +48,12 @@ oriented interface to DBUS enabled applications.</p> <p>Upon startup avahi-daemon interprets its configuration file - <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML fragments from - <file>@servicedir@/*.service</file> which may define static DNS-SD - services.</p> + <file>@pkgsysconfdir@/avahi-daemon.conf</file> and reads XML + fragments from <file>@servicedir@/*.service</file> which may + define static DNS-SD services. If you enable + <opt>publish-resolv-conf-dns-servers</opt> in + <file>avahi-daemon.conf</file> the file + <file>/etc/resolv.conf</file> will be read, too.</p> </description> <options> @@ -72,7 +75,14 @@ <option> <p><opt>-r | --reload</opt></p> - <optdesc><p>Tell an already running avahi-daemon to reread the files from <file>@servicedir@/</file>. Please note that this will not reload the <file>@pkgsysconfdir@/avahi-daemon.conf</file>(equivalent to sending a SIGHUP)</p></optdesc> + <optdesc><p>Tell an already running avahi-daemon to reread + <file>/etc/resolv.conf</file> (in case you enabled + <opt>publish-resolv-conf-dns-servers</opt> in + <file>avahi-daemon.conf</file>) the files from + <file>@servicedir@/</file>. Please note that this will not + reload the + <file>@pkgsysconfdir@/avahi-daemon.conf</file>(equivalent to + sending a SIGHUP)</p></optdesc> </option> <option> @@ -103,7 +113,9 @@ <section name="Signals"> <p><arg>SIGINT, SIGTERM, SIGQUIT</arg>: avahi-daemon will shutdown. This is issued by passing --kill to avahi-daemon.</p> - <p><arg>SIGHUP</arg>: avahi-daemon will reload the static service definitions from <file>@servicedir@/</file>.</p> + <p><arg>SIGHUP</arg>: avahi-daemon will reload unicast DNS + server data from <file>/etc/resolv.conf</file> and static + service definitions from <file>@servicedir@/</file>.</p> <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p> </section> diff --git a/man/avahi-daemon.conf.5.xml.in b/man/avahi-daemon.conf.5.xml.in new file mode 100644 index 0000000..45fdf9f --- /dev/null +++ b/man/avahi-daemon.conf.5.xml.in @@ -0,0 +1,192 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- + This file is part of avahi. + + avahi is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of the + License, or (at your option) any later version. + + avahi is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General + Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with avahi; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 + USA. +--> + + <manpage name="avahi-daemon.conf" section="5" desc="avahi-daemon configuration file"> + + <synopsis> + <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd> + </synopsis> + + <description> + <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p> + </description> + + <section name="Section [Server]"> + + <option> + <p><opt>host-name=</opt> Set the host name avahi-daemon tries + to register on the LAN. If omited defaults to the system host + name as set with the sethostname() system call.</p> + </option> + + <option> + <p><opt>domain-name=</opt> Set the domain name avahi-domain + tries to register its host name and services on the LAN in. If + omited defaults to ".local".</p> + </option> + + <option> + <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or + "no"). If set to "no" avahi-daemon will not use IPv4 + sockets. Default is "yes".</p> + </option> + + <option> + <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or + "no"). If set to "no" avahi-daemon will not use IPv6 + sockets. Default is "yes".</p> + </option> + + <option> + <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes" + or "no"). If set to "yes", an additional security check is + activated: incoming IP packets will be ignored unless the IP + TTL is 255. Earlier mDNS specifications required this + check. Since this feature may be incompatible with newer + implementations of mDNS it defaults to "no". On the other hand + it provides extra security.</p> + </option> + + <option> + <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or + "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING + flag bit which is used by some (modern) network drivers to + tell user space if a network cable is plugged in (in case of + copper ethernet), or the network card is associated with some + kind of network (in case of WLAN). If IFF_RUNNING is set + avahi-daemon will automatically announce its services on that + network. Unfortunately far too many network drivers do not + support this flag or support it in a broken way. Therefore + this option defaults to "no".</p> + </option> + + <option> + <p><opt>enable-dbus=</opt> Takes a boolean value ("yes" or + "no"). If set to "yes" avahi-daemon connects to DBUS, to offer + an object oriented client API. Only available if avahi has + been compiled with <opt>--enable-dbus</opt> in which case it + defaults to "yes".</p> + </option> + + </section> + + <section name="Section [publish]"> + <option> + <p><opt>publish-addresses=</opt> Takes a boolean value ("yes" + or "no"). If set to "yes" avahi-daemon will register mDNS + address records for all local IP addresses. Unless you want to + use avahi-daemon exclusively for browsing it's recommended to + enable this. If you plan to register local services you need + to enable this option. Defaults to "yes".</p> + </option> + + <option> + <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or + "no"). If set to "yes" avahi-daemon will register an mDNS + HINFO record on all interfaces which contains information + about the local operating system and CPU, which might be + useful for administrative purposes. This is recommended by the + mDNS specification but not required. For the sake of privacy + you might choose to disable this feature. Defaults to + "yes."</p> + </option> + + <option> + <p><opt>publish-workstation=</opt> Takes a boolean value + ("yes" or "no"). If set to "yes" avahi-daemon will register a + service of type "_workstation._tcp" on the local LAN. This + might be useful for administrative purposes (i.e. browse for + all PCs on the LAN), but is not required or recommended by any + specification. Newer MacOS X releases register a service of + this type. Defaults to "yes".</p> + </option> + + <option> + <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or + "no"). If set to "yes" avahi-daemon will announce the locally + used domain name (see above) for browsing by other + hosts. Defaults to "yes".</p> + </option> + + <option> + <p><opt>publish-dns-servers=</opt> Takes a comma seperated + list of IP addresses for unicast DNS servers. You can use this + to announce unicast DNS servers via mDNS. When used in + conjunction with avahi-dnsconfd on the client + side this allows DHCP-like configuration of unicast DNS + servers.</p> + </option> + + <option> + <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean + value ("yes" or "no"). If set to "yes" avahi-daemon will + publish the unicast DNS servers specified in + <file>/etc/resolv.conf</file> in addition to those specified + with <opt>publish-dns-servers</opt>. Send avahi-daemon a + SIGHUP to have it reload this file. Defaults to "no".</p> + </option> + + </section> + + <section name="Section [reflector]"> + <option> + <p><opt>enable-reflector=</opt> Takes a boolean value ("yes" + or "no"). If set to "yes" avahi-daemon will reflect incoming + mDNS requests to all local network interfaces, effectively + allowing clients to browse mDNS/DNS-SD services on all + networks connected to the gateway. The gateway is somewhat + intelligent and should work with all kinds of mDNS traffic, + though some functionality is lost (specifically the unicast + reply bit, which is used rarely anyway). Make sure to not run + multiple reflectors between the same networks, this might + cause them to play Ping Pong with mDNS packets. Defaults to + "no".</p> + </option> + + <option> + <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or + "no"). If set to "yes" and <opt>enable-reflector</opt> is + enabled, avahi-daemon will forward mDNS traffic between IPv4 + and IPv6, which is usually not recommended. Defaults to "no".</p> + </option> + </section> + + <section name="Authors"> + <p>The avahi developers <@PACKAGE_BUGREPORT@>; avahi is + available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/> + </p> + </section> + + <section name="Comments"> + <p>This man page was written using <manref name="xml2man" section="1" + href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p> + </section> + + </manpage> |