From: Lennart Poettering
Date: Sun, 7 Aug 2005 19:24:44 +0000 (+0000)
Subject: add man page for avahi-daemon.conf
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=88a99a094e561b6c87404f4999e61e7b9ed754f6;p=catta
add man page for avahi-daemon.conf
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@260 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
diff --git a/avahi-daemon/introspect.xsl b/avahi-daemon/introspect.xsl
index 206de57..38b443c 100644
--- a/avahi-daemon/introspect.xsl
+++ b/avahi-daemon/introspect.xsl
@@ -18,7 +18,7 @@
.keyword { font-style: italic }
.type { font-weight: bold }
.symbol { font-family: monospace }
- .interface { background: #efefef; padding: 10px; margin: 10px }
+ .interface { padding: 10px; margin: 10px }
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.
Upon startup avahi-daemon interprets its configuration file
- @pkgsysconfdir@/avahi-daemon.conf and reads XML fragments from
- @servicedir@/*.service which may define static DNS-SD
- services.
+ @pkgsysconfdir@/avahi-daemon.conf and reads XML
+ fragments from @servicedir@/*.service which may
+ define static DNS-SD services. If you enable
+ publish-resolv-conf-dns-servers in
+ avahi-daemon.conf the file
+ /etc/resolv.conf will be read, too.
@@ -72,7 +75,14 @@
-r | --reload
- Tell an already running avahi-daemon to reread the files from @servicedir@/ . Please note that this will not reload the @pkgsysconfdir@/avahi-daemon.conf (equivalent to sending a SIGHUP)
+ Tell an already running avahi-daemon to reread
+ /etc/resolv.conf (in case you enabled
+ publish-resolv-conf-dns-servers in
+ avahi-daemon.conf ) the files from
+ @servicedir@/ . Please note that this will not
+ reload the
+ @pkgsysconfdir@/avahi-daemon.conf (equivalent to
+ sending a SIGHUP)
@@ -103,7 +113,9 @@
SIGINT, SIGTERM, SIGQUIT : avahi-daemon will shutdown. This is issued by passing --kill to avahi-daemon.
- SIGHUP : avahi-daemon will reload the static service definitions from @servicedir@/ .
+ SIGHUP : avahi-daemon will reload unicast DNS
+ server data from /etc/resolv.conf and static
+ service definitions from @servicedir@/ .
SIGUSR1 : avahi-daemon will dump local and remote cached resource record data to syslog.
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 @@
+
+
+
+
+
+
+
+
+
+
+
+ @pkgsysconfdir@/avahi-daemon.conf
+
+
+
+ avahi-daemon.conf is the configuration file for avahi-daemon.
+
+
+
+
+
+ host-name= 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.
+
+
+
+ domain-name= Set the domain name avahi-domain
+ tries to register its host name and services on the LAN in. If
+ omited defaults to ".local".
+
+
+
+ use-ipv4= Takes a boolean value ("yes" or
+ "no"). If set to "no" avahi-daemon will not use IPv4
+ sockets. Default is "yes".
+
+
+
+ use-ipv6= Takes a boolean value ("yes" or
+ "no"). If set to "no" avahi-daemon will not use IPv6
+ sockets. Default is "yes".
+
+
+
+ check-response-ttl= 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.
+
+
+
+ use-iff-running= 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".
+
+
+
+ enable-dbus= 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 --enable-dbus in which case it
+ defaults to "yes".
+
+
+
+
+
+
+ publish-addresses= 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".
+
+
+
+ publish-hinfo= 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."
+
+
+
+ publish-workstation= 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".
+
+
+
+ publish-domain= 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".
+
+
+
+ publish-dns-servers= 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.
+
+
+
+ publish-resolv-conf-dns-servers= Takes a boolean
+ value ("yes" or "no"). If set to "yes" avahi-daemon will
+ publish the unicast DNS servers specified in
+ /etc/resolv.conf in addition to those specified
+ with publish-dns-servers . Send avahi-daemon a
+ SIGHUP to have it reload this file. Defaults to "no".
+
+
+
+
+
+
+ enable-reflector= 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".
+
+
+
+ reflect-ipv= Takes a boolean value ("yes" or
+ "no"). If set to "yes" and enable-reflector is
+ enabled, avahi-daemon will forward mDNS traffic between IPv4
+ and IPv6, which is usually not recommended. Defaults to "no".
+
+
+
+
+ The avahi developers <@PACKAGE_BUGREPORT@>; avahi is
+ available from
+
+
+
+
+
+ This man page was written using by Oliver Kurth.
+
+
+