diff options
author | Lennart Poettering <lennart@poettering.net> | 2005-08-07 10:49:51 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2005-08-07 10:49:51 +0000 |
commit | f5f30ed5cad14cc2543fdd47645513abd3c694e9 (patch) | |
tree | 7b4a31bfe04b2814c0b3678b553785d6d45a39d5 | |
parent | b2abf404e9d5b8f156f359c6ab0ee444ba61322e (diff) |
add man page for avahi-daemon
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@256 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
-rw-r--r-- | man/Makefile.am | 39 | ||||
-rw-r--r-- | man/avahi-browse.1.xml.in | 4 | ||||
-rw-r--r-- | man/avahi-daemon.8.xml.in | 126 | ||||
-rw-r--r-- | man/avahi-publish-service.1.xml.in | 2 |
4 files changed, 152 insertions, 19 deletions
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 @@ <synopsis> <cmd>avahi-browse [<arg>options</arg>] <arg>service-type</arg></cmd> - <cmd>avahi-browse [<arg>options</arg>] <opt>-a</opt></cmd> - <cmd>avahi-browse <opt>-h</opt></cmd> + <cmd>avahi-browse [<arg>options</arg>] <opt>--all</opt></cmd> + <cmd>avahi-browse <opt>--help</opt></cmd> </synopsis> <description> 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 @@ +<?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" section="8" desc="The Avahi mDNS/DNS-SD daemon"> + + <synopsis> + <cmd>avahi-daemon [<arg>options</arg>]</cmd> + <cmd>avahi-daemon <opt>--kill</opt></cmd> + <cmd>avahi-daemon <opt>--reload</opt></cmd> + <cmd>avahi-daemon <opt>--check</opt></cmd> + <cmd>avahi-daemon <opt>--version</opt></cmd> + <cmd>avahi-daemon <opt>--help</opt></cmd> + </synopsis> + + <description> + <p>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.</p> + + <p>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.</p> + </description> + + <options> + + <option> + <p><opt>-f | --file=</opt> <arg>FILE</arg></p> + <optdesc><p>Specify the configuration file to read. (default: @pkgsysconfdir@/avahi-daemon.conf)</p></optdesc> + </option> + + <option> + <p><opt>-D | --daemonize</opt></p> + <optdesc><p>Daemonize avahi-daemon after startup and redirect log messages to syslog.</p></optdesc> + </option> + + <option> + <p><opt>-k | --kill</opt></p> + <optdesc><p>Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)</p></optdesc> + </option> + + <option> + <p><opt>-r | --reload</opt></p> + <optdesc><p>Tell an already running avahi-daemon to reread the files from @servicedir@/. (equivalent to sending a SIGHUP)</p></optdesc> + </option> + + <option> + <p><opt>-c | --check</opt></p> + <optdesc><p>Return 0 as return code when avahi-daemon is already running.</p></optdesc> + </option> + + <option> + <p><opt>-h | --help</opt></p> + <optdesc><p>Show help</p></optdesc> + </option> + + <option> + <p><opt>-v | --version</opt></p> + <optdesc><p>Show version information </p></optdesc> + </option> + + </options> + + + <section name="Files"> + + <p><file>@pkgsysconfdir@/avahi-daemon.conf</file>: the default configuration file for avahi-daemon.</p> + + <p><file>@servicedir@/*.service</file>: static service definitions.</p> + + </section> + + <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 @servicedir@/.</p> + <p><arg>SIGUSR1</arg>: avahi-daemon will dump local and remote cached resource record data to syslog.</p> + </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-dnsconfd" section="8"/>, <manref name="avahi-daemon.conf" section="5"/> + </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> 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 @@ <synopsis> <cmd>avahi-publish-service [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg></cmd> - <cmd>avahi-publish-service <opt>-h</opt></cmd> + <cmd>avahi-publish-service <opt>--help</opt></cmd> </synopsis> <description> |