From f2af862d6619dba39ba056c9ffb5fc9c7e9fc59c Mon Sep 17 00:00:00 2001
From: Lennart Poettering
Date: Wed, 16 Nov 2005 14:06:19 +0000
Subject: [PATCH] update man pages
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@981 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
avahi-daemon/avahi-daemon.conf | 4 +-
avahi-daemon/main.c | 8 +-
man/Makefile.am | 33 ++++-----
man/avahi-bookmarks.1.xml.in | 17 +++--
man/avahi-browse.1.xml.in | 63 +++++++++++++---
man/avahi-daemon.8.xml.in | 19 +++--
man/avahi-daemon.conf.5.xml.in | 61 +++++++++++++--
man/avahi-dnsconfd.8.xml.in | 3 -
man/avahi-resolve-address.1.xml.in | 60 ---------------
man/avahi-resolve-host-name.1.xml.in | 60 ---------------
man/avahi-resolve.1.xml.in | 107 +++++++++++++++++++++++++++
11 files changed, 263 insertions(+), 172 deletions(-)
delete mode 100644 man/avahi-resolve-address.1.xml.in
delete mode 100644 man/avahi-resolve-host-name.1.xml.in
create mode 100644 man/avahi-resolve.1.xml.in
diff --git a/avahi-daemon/avahi-daemon.conf b/avahi-daemon/avahi-daemon.conf
index 14b4a0a..f2ffcc3 100644
--- a/avahi-daemon/avahi-daemon.conf
+++ b/avahi-daemon/avahi-daemon.conf
@@ -30,13 +30,13 @@ use-ipv6=no
#use-iff-running=no
#enable-dbus=yes
#disallow-other-stacks=no
-#disable-publishing=no
-#disable-user-service-publishing=no
[wide-area]
enable-wide-area=yes
[publish]
+#disable-publishing=no
+#disable-user-service-publishing=no
#add-service-cookie=yes
#publish-addresses=yes
#publish-hinfo=yes
diff --git a/avahi-daemon/main.c b/avahi-daemon/main.c
index 12af74c..da19868 100644
--- a/avahi-daemon/main.c
+++ b/avahi-daemon/main.c
@@ -487,10 +487,6 @@ static int load_config_file(DaemonConfig *c) {
c->server_config.use_iff_running = is_yes(p->value);
else if (strcasecmp(p->key, "disallow-other-stacks") == 0)
c->server_config.disallow_other_stacks = is_yes(p->value);
- else if (strcasecmp(p->key, "disable-publishing") == 0)
- c->server_config.disable_publishing = is_yes(p->value);
- else if (strcasecmp(p->key, "disable-user-service-publishing") == 0)
- c->disable_user_service_publishing = is_yes(p->value);
#ifdef HAVE_DBUS
else if (strcasecmp(p->key, "enable-dbus") == 0) {
@@ -526,6 +522,10 @@ static int load_config_file(DaemonConfig *c) {
c->server_config.publish_domain = is_yes(p->value);
else if (strcasecmp(p->key, "publish-resolv-conf-dns-servers") == 0)
c->publish_resolv_conf = is_yes(p->value);
+ else if (strcasecmp(p->key, "disable-publishing") == 0)
+ c->server_config.disable_publishing = is_yes(p->value);
+ else if (strcasecmp(p->key, "disable-user-service-publishing") == 0)
+ c->disable_user_service_publishing = is_yes(p->value);
else if (strcasecmp(p->key, "add-service-cookie") == 0)
c->server_config.add_service_cookie = is_yes(p->value);
else if (strcasecmp(p->key, "publish-dns-servers") == 0) {
diff --git a/man/Makefile.am b/man/Makefile.am
index d80c885..4beb7cb 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -33,8 +33,7 @@ noinst_DATA = \
avahi-browse.1.xml \
avahi-publish-service.1.xml \
avahi-publish-address.1.xml \
- avahi-resolve-address.1.xml \
- avahi-resolve-host-name.1.xml \
+ avahi-resolve.1.xml \
avahi-daemon.8.xml \
avahi-discover.1.xml \
avahi-bookmarks.1.xml \
@@ -46,18 +45,18 @@ noinst_DATA = \
CLEANFILES = \
$(noinst_DATA)
-if HAVE_PYTHON
if HAVE_DBUS
man_MANS += \
avahi-browse.1 \
+ avahi-resolve.1
+
+if HAVE_PYTHON
+man_MANS += \
avahi-publish-service.1 \
avahi-publish-address.1 \
- avahi-resolve-address.1 \
- avahi-resolve-host-name.1 \
avahi-discover.1 \
avahi-bookmarks.1
-
endif
endif
@@ -73,11 +72,7 @@ avahi-publish-address.1.xml: avahi-publish-address.1.xml.in Makefile
sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
-avahi-resolve-address.1.xml: avahi-resolve-address.1.xml.in Makefile
- sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
- -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
-
-avahi-resolve-host-name.1.xml: avahi-resolve-host-name.1.xml.in Makefile
+avahi-resolve.1.xml: avahi-resolve.1.xml.in Makefile
sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
@@ -130,10 +125,7 @@ avahi-publish-service.1: avahi-publish-service.1.xml Makefile
avahi-publish-address.1: avahi-publish-address.1.xml Makefile
xmltoman $< > $@
-avahi-resolve-address.1: avahi-resolve-address.1.xml Makefile
- xmltoman $< > $@
-
-avahi-resolve-host-name.1: avahi-resolve-host-name.1.xml Makefile
+avahi-resolve.1: avahi-resolve.1.xml Makefile
xmltoman $< > $@
avahi-daemon.8: avahi-daemon.8.xml Makefile
@@ -172,8 +164,7 @@ EXTRA_DIST = \
avahi-browse.1.xml.in \
avahi-publish-service.1.xml.in \
avahi-publish-address.1.xml.in \
- avahi-resolve-address.1.xml.in \
- avahi-resolve-host-name.1.xml.in \
+ avahi-resolve.1.xml.in \
avahi-daemon.8.xml.in \
avahi-discover.1.xml.in \
avahi-bookmarks.1.xml.in \
@@ -184,3 +175,11 @@ EXTRA_DIST = \
xmltoman.css \
xmltoman.xsl \
xmltoman.dtd
+
+
+if HAVE_DBUS
+
+install-exec-local:
+ cd $(DESTDIR)/$(mandir)/man1 && rm -f avahi-resolve-host-name.1 avahi-resolve-address.1 && $(LN_S) avahi-resolve.1 avahi-resolve-host-name.1 && $(LN_S) avahi-resolve.1 avahi-resolve-address.1
+
+endif
diff --git a/man/avahi-bookmarks.1.xml.in b/man/avahi-bookmarks.1.xml.in
index 58c791c..f43fa46 100644
--- a/man/avahi-bookmarks.1.xml.in
+++ b/man/avahi-bookmarks.1.xml.in
@@ -30,12 +30,12 @@
- Web service showing mDNS/DNS-SD announced HTTP services using
- the Avahi daemon. avahi-bookmarks opens an TCP port 8080 and
- waits for incoming HTTP connections returning a dynamic web site
- containing links to all services of type _http._tcp on the
- LAN. Point your browser to http://localhost:8080/ to make use of
- avahi-bookmarks.
+ A web service for listing HTTP services that are announced
+ via mDNS/DNS-SD using the Avahi daemon. avahi-bookmarks opens a
+ TCP socket on port 8080 and waits for incoming HTTP connections
+ returning a dynamic web site containing links to all services of
+ type _http._tcp on the LAN. Point your browser to
+ http://localhost:8080/ to make use of avahi-bookmarks.
@@ -58,6 +58,11 @@
mDNS host names (e.g. nss-mdns).
+
+ -d | --domain DOMAIN
+ The domain to browse for services in.
+
+
-h | --help
Show help
diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in
index b6f2da1..6bf8103 100644
--- a/man/avahi-browse.1.xml.in
+++ b/man/avahi-browse.1.xml.in
@@ -28,11 +28,11 @@
avahi-browse [options ] service-type
avahi-browse [options ] --all
- avahi-browse --help
+ avahi-browse [options ] --browse-domains
- Browse for mDNS/DNS-SD network services using the Avahi daemon.
+ Browse for mDNS/DNS-SD network services and browsing domains using the Avahi daemon.
@@ -40,23 +40,68 @@
Specify a DNS-SD service type (e.g. _http._tcp) to browse for
on the command line, or -a to browse for all
- available service types.
+ available service types. Items that appear on the network are prefixed with "+", items that disappear are prefixed with "-".
-
+
-a | --all
Browse for all service types registered on the LAN, not just the one specified on the command line.
-
+
+ -D | --browse-domains
+ Browse for browsing domains instead for services.
+
+
+
-d | --domain= DOMAIN
- Just browse in the specified domain. If omited
- avahi-browse will browse in .local and all other browse
- domains announced on the LAN.
+ Browse in the specified domain. If omitted
+ avahi-browse will browse in the default browsing domain
+ (usually .local)
+
+ -v | --verbose
+ Enable verbose mode.
+
+
+
+ -t | --terminate
+ Terminate after dumping a more or less complete list.
+
+
+
+ -c | --cache
+ Terminate after dumping all entries available in the cache.
+
+
+
+ -l | --ignore-local
+ Ignore local services, show only remote services.
+
+
-h | --help
- Show help
+ Show help.
+
+
+
+ -r | --resolve
+ Automatically resolve services found.
+
+
+
+ -f | --no-fail
+ Don't fail if the service is not found running. Instead, wait until it appears. If it disconnects, try to reconnect.
+
+
+
+ -k | --no-db-lookup
+ Don't lookup services types in service type database.
+
+
+
+ -V | --version
+ Show version information.
diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in
index ce8ab81..1c949be 100644
--- a/man/avahi-daemon.8.xml.in
+++ b/man/avahi-daemon.8.xml.in
@@ -30,8 +30,6 @@
avahi-daemon --kill
avahi-daemon --reload
avahi-daemon --check
- avahi-daemon --version
- avahi-daemon --help
@@ -88,6 +86,19 @@
Don't drop root priviliges after startup and don't require daemon to be started as root. We recommend not to use this option.
+
+ --no-chroot
+ Don't the daemon. This option is only available when compiled with chroot() support.
+
+
+
+ --no-proctitle
+ Don't change the process name while
+ running. Unless this option is specified avahi will reflect
+ it's current state and selected host name in the process
+ title.
+
+
-k | --kill
Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)
@@ -101,7 +112,7 @@
avahi-daemon.conf ) the files from
@servicedir@/ . Please note that this will not
reload the
- @pkgsysconfdir@/avahi-daemon.conf (equivalent to
+ @pkgsysconfdir@/avahi-daemon.conf . (equivalent to
sending a SIGHUP)
@@ -120,10 +131,8 @@
Show version information
-
-
@pkgsysconfdir@/avahi-daemon.conf : the default configuration file for avahi-daemon.
diff --git a/man/avahi-daemon.conf.5.xml.in b/man/avahi-daemon.conf.5.xml.in
index 89aa38e..030d82d 100644
--- a/man/avahi-daemon.conf.5.xml.in
+++ b/man/avahi-daemon.conf.5.xml.in
@@ -42,9 +42,21 @@
- domain-name= Set the domain name avahi-domain
+
domain-name= Set the default domain name avahi-daemon
tries to register its host name and services on the LAN in. If
- omited defaults to ".local".
+ omitted defaults to ".local".
+
+
+
+ browse-domains= Set a comma seperated list of
+ browsing domains (in addition to the default one and those
+ announced inside the default browsing domain). Please note
+ that the user may specify additional browsing domains on the
+ client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
+ of colon seperated domains or by adding them to the XDG config
+ file ~/.config/avahi/browse-domains (seperated by
+ newlines).
+
@@ -92,6 +104,47 @@
D-BUS daemon.
+
+ disallow-other-stacks= Takes a boolean value
+ ("yes" or "no"). If set to "yes", no other process is allowed
+ to bind to UDP port 5353. This effectively impedes other mDNS
+ stacks from running on the host. Use this as a security
+ measure to make sure that only Avahi is responsible for mDNS
+ traffic. Please note that we do no recommend running multiple
+ mDNS stacks on the same host simultaneously. This hampers
+ reliability and is a waste of resources. However, to not annoy
+ people this option defaults to "no".
+
+
+
+
+
+
+ enable-wide-area= Enable wide-area DNS-SD, aka
+ DNS-SD over unicast DNS. If this is enabled only domains
+ ending in .local will be resolved on mDNS, all other domains
+ are resolved via unicast DNS. If you want to maintain multiple
+ different multicast DNS domains even with this option enabled
+ we encourage you to use subdomains of .local, such as
+ "kitchen.local". This option defaults to "yes".
+
+
+
+
+
+
+ disable-publishing= Takes a boolean value
+ ("yes" or "no"). If set to "yes", no record will be published by
+ Avahi, not even address records for the local host. Avahi will
+ be started in a querying-only mode. Use this is a security
+ measure. This option defaults to "no"
+
+ disable-publishing= Takes a boolean value
+ ("yes" or "no"). If set to "yes", Avahi will still publish
+ address records and suchlike but will not allow user
+ applications to publish services. Use this is a security
+ measure. This option defaults to "no"
+
add-service-cookie= Takes a boolean value ("yes"
or "no"). If set to "yes" an implicit TXT entry will be added
@@ -102,10 +155,6 @@
"yes".
-
-
-
-
publish-addresses= Takes a boolean value ("yes"
or "no"). If set to "yes" avahi-daemon will register mDNS
diff --git a/man/avahi-dnsconfd.8.xml.in b/man/avahi-dnsconfd.8.xml.in
index 6532319..4348d74 100644
--- a/man/avahi-dnsconfd.8.xml.in
+++ b/man/avahi-dnsconfd.8.xml.in
@@ -30,8 +30,6 @@
avahi-dnsconfd --kill
avahi-dnsconfd --refresh
avahi-dnsconfd --check
- avahi-dnsconfd --version
- avahi-dnsconfd --help
@@ -76,7 +74,6 @@
-
@pkgsysconfdir@/dnsconf.action : the script to run when a DNS server is found or removed.
diff --git a/man/avahi-resolve-address.1.xml.in b/man/avahi-resolve-address.1.xml.in
deleted file mode 100644
index 234f1f3..0000000
--- a/man/avahi-resolve-address.1.xml.in
+++ /dev/null
@@ -1,60 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- avahi-resolve-address address ...
-
-
-
- Resolve one or more IP address(es) to mDNS host name(s) using the Avahi daemon ("reverse name lookup").
-
-
-
-
- Specify one or more IP address(es) (e.g. "192.168.50.1" or "2001:db8:0:1::1") for being resolved into host names on the command line.
-
-
-
-
- The avahi developers <@PACKAGE_BUGREPORT@>; avahi is
- available from
-
-
-
-
-
- This man page was written using by Oliver Kurth.
-
-
-
diff --git a/man/avahi-resolve-host-name.1.xml.in b/man/avahi-resolve-host-name.1.xml.in
deleted file mode 100644
index 9c9b0a6..0000000
--- a/man/avahi-resolve-host-name.1.xml.in
+++ /dev/null
@@ -1,60 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- avahi-resolve-host-name host-name ...
-
-
-
- Resolve one or more mDNS host name(s) to IP address(es) using the Avahi daemon
-
-
-
-
- Specify one or more mDNS host name(s) (e.g. "foo.local") for being resolved into IP addresses on the command line.
-
-
-
-
- The avahi developers <@PACKAGE_BUGREPORT@>; avahi is
- available from
-
-
-
-
-
- This man page was written using by Oliver Kurth.
-
-
-
diff --git a/man/avahi-resolve.1.xml.in b/man/avahi-resolve.1.xml.in
new file mode 100644
index 0000000..f3691b9
--- /dev/null
+++ b/man/avahi-resolve.1.xml.in
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+
+
+
+
+ avahi-resolve --name host-name ...
+ avahi-resolve-host-name host-name ...
+ avahi-resolve --address address ...
+ avahi-resolve-address address ...
+
+
+
+ Resolve one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon.
+
+
+
+
+ When passing -n, specify one or more fully qualified mDNS/DNS host name(s)
+ (e.g. "foo.local") to resolve into IP addresses on the
+ command line. When passing -a, specifiy one or more IP address
+ to resolve into host names.
+
+ avahi-resolve-host-name is equivalent to avahi-resolve --name.
+
+ avahi-resolve-address is equivalent to avahi-resolve --address.
+
+
+ -n | --name
+ Translate one or more fully qualified host names into addresses.
+
+
+
+ -a | --address
+ Translate one or more addresses into fully qualified host names.
+
+
+
+ -v | --verbose
+ Enable verbose mode.
+
+
+
+ -6
+ When resolving a host name, look for IPv6 addresses exclusively.
+
+
+
+ -4
+ When resolving a host name, look for IPv4 addresses exclusively.
+
+
+
+ -h | --help
+ Show help.
+
+
+
+
+ -V | --version
+ Show version information.
+
+
+
+
+
+
+ The avahi developers <@PACKAGE_BUGREPORT@>; avahi is
+ available from
+
+
+
+
+
+ This man page was written using by Oliver Kurth.
+
+
+
--
2.39.5