From f5f30ed5cad14cc2543fdd47645513abd3c694e9 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 7 Aug 2005 10:49:51 +0000 Subject: add man page for avahi-daemon git-svn-id: file:///home/lennart/svn/public/avahi/trunk@256 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe --- man/Makefile.am | 39 +++++++----- man/avahi-browse.1.xml.in | 4 +- man/avahi-daemon.8.xml.in | 126 +++++++++++++++++++++++++++++++++++++ man/avahi-publish-service.1.xml.in | 2 +- 4 files changed, 152 insertions(+), 19 deletions(-) create mode 100644 man/avahi-daemon.8.xml.in (limited to 'man') diff --git a/man/Makefile.am b/man/Makefile.am index 1fa4723..bcc3d11 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -17,9 +17,15 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 # USA. -if HAVE_PYTHON +pkgsysconfdir=$(sysconfdir)/avahi +servicedir=$(pkgsysconfdir)/services man_MANS = \ + avahi-daemon.8 + +if HAVE_PYTHON + +man_MANS += \ avahi-browse.1 \ avahi-publish-service.1 \ avahi-publish-address.1 \ @@ -33,7 +39,8 @@ noinst_DATA = \ avahi-publish-service.1.xml \ avahi-publish-address.1.xml \ avahi-resolve-address.1.xml \ - avahi-resolve-host-name.1.xml + avahi-resolve-host-name.1.xml \ + avahi-daemon.8.xml EXTRA_DIST = \ $(man_MANS) \ @@ -42,6 +49,7 @@ EXTRA_DIST = \ avahi-publish-address.1.xml.in \ avahi-resolve-address.1.xml.in \ avahi-resolve-host-name.1.xml.in \ + avahi-daemon.8.xml.in \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd @@ -50,32 +58,28 @@ CLEANFILES = \ $(noinst_DATA) avahi-browse.1.xml: avahi-browse.1.xml.in Makefile - sed -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@sbindir\@,$(sbindir),g' \ - -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ avahi-publish-service.1.xml: avahi-publish-service.1.xml.in Makefile - sed -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@sbindir\@,$(sbindir),g' \ - -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ avahi-publish-address.1.xml: avahi-publish-address.1.xml.in Makefile - sed -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@sbindir\@,$(sbindir),g' \ - -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + 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,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@sbindir\@,$(sbindir),g' \ - -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + 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 - sed -e 's,@sysconfdir\@,$(sysconfdir),g' \ - -e 's,@sbindir\@,$(sbindir),g' \ + sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +avahi-daemon.8.xml: avahi-daemon.8.xml.in Makefile + sed -e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \ + -e 's,@servicedir\@,$(servicedir),g' \ -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ @@ -98,4 +102,7 @@ avahi-resolve-address.1: avahi-resolve-address.1.xml Makefile avahi-resolve-host-name.1: avahi-resolve-host-name.1.xml Makefile xmltoman $< > $@ +avahi-daemon.8: avahi-daemon.8.xml Makefile + xmltoman $< > $@ + endif diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in index 580d8c7..b6f2da1 100644 --- a/man/avahi-browse.1.xml.in +++ b/man/avahi-browse.1.xml.in @@ -27,8 +27,8 @@ avahi-browse [options] service-type - avahi-browse [options] -a - avahi-browse -h + avahi-browse [options] --all + avahi-browse --help diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in new file mode 100644 index 0000000..3e461ac --- /dev/null +++ b/man/avahi-daemon.8.xml.in @@ -0,0 +1,126 @@ + + + + + + + + + + + + avahi-daemon [options] + avahi-daemon --kill + avahi-daemon --reload + avahi-daemon --check + avahi-daemon --version + avahi-daemon --help + + + +

The Avahi mDNS/DNS-SD daemon implementing Apple's ZeroConf + architecture (also known as "Rendezvous" or "Bonjour"). The daemon + registers local IP addresses and static services using + mDNS/DNS-SD and provides two IPC APIs for local programs to make + use of the mDNS record cache the avahi-daemon maintains. First + there is the so called "simple protocol" which is used + exclusively by avahi-dnsconfd (a daemon which configures unicast + DNS servers using server info published via mDNS) and nss-mdns + (a libc NSS plugin, providing name resolution via mDNS). Finally + there is the DBUS interface which provides a rich object + oriented interface to DBUS enabled applications.

+ +

Upon startup avahi-daemon interpretes 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: the default configuration file for avahi-daemon.

+ +

@servicedir@/*.service: static service definitions.

+ +
+ +
+

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@/.

+

SIGUSR1: avahi-daemon will dump local and remote cached resource record data to syslog.

+
+ +
+

The avahi developers <@PACKAGE_BUGREPORT@>; avahi is + available from

+
+ +
+

+ , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + diff --git a/man/avahi-publish-service.1.xml.in b/man/avahi-publish-service.1.xml.in index 2f5e7a8..be622be 100644 --- a/man/avahi-publish-service.1.xml.in +++ b/man/avahi-publish-service.1.xml.in @@ -27,7 +27,7 @@ avahi-publish-service [options] name service-type port - avahi-publish-service -h + avahi-publish-service --help -- cgit