diff options
author | Lennart Poettering <lennart@poettering.net> | 2005-08-07 20:44:37 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2005-08-07 20:44:37 +0000 |
commit | aa437b5722b757e3faab5af1f00f14c9ef95018f (patch) | |
tree | 0c3cd956495a9a6fa96f5e2c976e7d85dd7f982d | |
parent | d66b47f2d2d6dfcf40faad7d4c94d46ac405ebf0 (diff) |
add avahi.service man page
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@264 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
-rw-r--r-- | man/Makefile.am | 17 | ||||
-rw-r--r-- | man/avahi-dnsconfd.8.xml.in | 2 | ||||
-rw-r--r-- | man/avahi.service.5.xml.in | 114 |
3 files changed, 130 insertions, 3 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index f9d226a..d253ddb 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -24,7 +24,8 @@ man_MANS = \ avahi-daemon.8 \ avahi-dnsconfd.8 \ avahi-daemon.conf.5 \ - avahi-dnsconfd.action.8 + avahi-dnsconfd.action.8 \ + avahi.service.5 if HAVE_PYTHON @@ -50,7 +51,8 @@ noinst_DATA = \ avahi-bookmarks.1.xml \ avahi-dnsconfd.8.xml \ avahi-daemon.conf.5.xml \ - avahi-dnsconfd.action.8.xml + avahi-dnsconfd.action.8.xml \ + avahi.service.5.xml EXTRA_DIST = \ $(man_MANS) \ @@ -65,6 +67,7 @@ EXTRA_DIST = \ avahi-dnsconfd.8.xml.in \ avahi-daemon.conf.5.xml.in \ avahi-dnsconfd.action.8.xml.in \ + avahi.service.5.xml.in \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd @@ -121,6 +124,12 @@ avahi-dnsconfd.action.8.xml: avahi-dnsconfd.action.8.xml.in Makefile -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ +avahi.service.5.xml: avahi.service.5.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' $< > $@ + if USE_XMLTOMAN @@ -159,6 +168,10 @@ avahi-daemon.conf.5: avahi-daemon.conf.5.xml Makefile avahi-dnsconfd.action.8: avahi-dnsconfd.action.8.xml Makefile xmltoman $< > $@ +avahi.service.5: avahi.service.5.xml Makefile + xmltoman $< > $@ + + xmllint: $(noinst_DATA) for f in $(noinst_DATA) ; do \ xmllint --noout --valid "$$f" || exit 1 ; \ diff --git a/man/avahi-dnsconfd.8.xml.in b/man/avahi-dnsconfd.8.xml.in index bd99f47..6532319 100644 --- a/man/avahi-dnsconfd.8.xml.in +++ b/man/avahi-dnsconfd.8.xml.in @@ -31,7 +31,7 @@ <cmd>avahi-dnsconfd <opt>--refresh</opt></cmd> <cmd>avahi-dnsconfd <opt>--check</opt></cmd> <cmd>avahi-dnsconfd <opt>--version</opt></cmd> - <cmd>avahi-dnsconfd<opt>--help</opt></cmd> + <cmd>avahi-dnsconfd <opt>--help</opt></cmd> </synopsis> <description> diff --git a/man/avahi.service.5.xml.in b/man/avahi.service.5.xml.in new file mode 100644 index 0000000..4814184 --- /dev/null +++ b/man/avahi.service.5.xml.in @@ -0,0 +1,114 @@ +<?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.service" section="5" desc="avahi-daemon static service file"> + + <synopsis> + <cmd>@servicedir@/*.service</cmd> + </synopsis> + + <description> <p><file>@servicedir@/*.service</file> are XML + fragments containing static DNS-SD service data. Every service + file can contain multiple service definitions which share the + same name. This is useful for publishing service data for + services which implement multiple protocols. (i.e. a printer + implementing _ipp._tcp and _printer.tcp)</p> </description> + + <section name="XML Tags"> + + <option> + <p><opt><service-group></opt> The document tag of avahi + service files. Should contain one <opt><name></opt> and one or more + <opt><service></opt> elements.</p> + </option> + + <option> + <p><opt><name replace-wildcards="yes|no"/></opt> The + service name. If <opt>replace-wildcards</opt> is "yes", any + occurence of the string "%h" will be replaced by the local + host name. This can be used for service names like "Remote + Terminal on %h". If <opt>replace-wildcards</opt> is not + specified, defaults to "no".</p> + </option> + + <option> + <p><opt><service></opt> Contains the service information + for exactly one service type. Should contain one + <opt><type></opt> and one <opt><port></opt> + element. Optionally it may contain one + <opt><domain-name></opt>, one + <opt><host-name></opt> and multiple + <opt><txt-record></opt> elements.</p> + </option> + + + <option> + <p><opt><type></opt> Contains the DNS-SD service type for this service. i.e. "_http._tcp".</p> + </option> + + <option> + <p><opt><domain-name></opt> The domain name this service + should be registered. If omited defaults to the default domain + of the avahi daemon. (probably .local)</p> + </option> + + <option> + <p><opt><host-name></opt> The host name of the host that + provides this service. This should be a mDNS resolvable host + name. Please note that you need to specify a fully-qualified + domain name (FQDN) here, i.e. .local is not appended! The host + name needs not to be part of the domain specified in + <opt><domain-name></opt>.</p> + </option> + + <option> + <p><opt><port></opt> The IP port number the service listens on.</p> + </option> + + <option> + <p><opt><txt-record></opt> DNS-SD TXT record data.</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"/> + </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> |