summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2005-08-06 21:28:30 +0000
committerLennart Poettering <lennart@poettering.net>2005-08-06 21:28:30 +0000
commitc795762e33cffa32c1d5d8e45b12c8b1b7ca93e1 (patch)
tree229b3508568ef4463f5c83ba04dd71f5f5543cb6 /man
parentdfb41086575fe9e594283a1544e52581a5e392c3 (diff)
add man page for avahi-publish-service
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@251 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am18
-rw-r--r--man/avahi-browse.1.xml.in10
-rw-r--r--man/avahi-publish-service.1.xml.in84
3 files changed, 105 insertions, 7 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 2d382ee..ddf9c2e 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -17,14 +17,18 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA.
-man_MANS = avahi-browse.1
+man_MANS = \
+ avahi-browse.1 \
+ avahi-publish-service.1
noinst_DATA = \
- avahi-browse.1.xml
+ avahi-browse.1.xml \
+ avahi-publish-service.1.xml
EXTRA_DIST = \
$(man_MANS) \
avahi-browse.1.xml.in \
+ avahi-publish-service.1.xml.in \
xmltoman.css \
xmltoman.xsl \
xmltoman.dtd
@@ -38,6 +42,12 @@ avahi-browse.1.xml: avahi-browse.1.xml.in Makefile
-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' \
+ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
if USE_XMLTOMAN
CLEANFILES += $(man_MANS)
@@ -45,4 +55,8 @@ CLEANFILES += $(man_MANS)
avahi-browse.1: avahi-browse.1.xml Makefile
xmltoman $< > $@
+avahi-publish-service.1: avahi-publish-service.1.xml Makefile
+ xmltoman $< > $@
+
+
endif
diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in
index 832fda0..580d8c7 100644
--- a/man/avahi-browse.1.xml.in
+++ b/man/avahi-browse.1.xml.in
@@ -48,17 +48,17 @@
</option>
<option>
- <p><opt>-h | --help</opt></p>
- <optdesc><p>Show help</p></optdesc>
- </option>
-
- <option>
<p><opt>-d | --domain=</opt> <arg>DOMAIN</arg></p>
<optdesc><p>Just browse in the specified domain. If omited
avahi-browse will browse in .local and all other browse
domains announced on the LAN.</p></optdesc>
</option>
+ <option>
+ <p><opt>-h | --help</opt></p>
+ <optdesc><p>Show help</p></optdesc>
+ </option>
+
</options>
<section name="Authors">
diff --git a/man/avahi-publish-service.1.xml.in b/man/avahi-publish-service.1.xml.in
new file mode 100644
index 0000000..4f68890
--- /dev/null
+++ b/man/avahi-publish-service.1.xml.in
@@ -0,0 +1,84 @@
+<?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-publish-service" section="1" desc="Register an mDNS/DNS-SD service using the Avahi daemon">
+
+ <synopsis>
+ <cmd>avahi-browse [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg></cmd>
+ <cmd>avahi-browse <opt>-h</opt></cmd>
+ </synopsis>
+
+ <description>
+ <p>Register an mDNS/DNS-SD service using the Avahi daemon.</p>
+ </description>
+
+ <options>
+
+ <p>Specify a DNS-SD service name (e.g. "Lennart's Files"), a
+ service type (e.g. _http._tcp) and an IP port number for the
+ service on the command line.</p>
+
+ <option>
+ <p><opt>-H | --host=</opt> <arg>HOSTNAME</arg></p>
+ <optdesc><p>Specify a host name for this service, in case it
+ doesn't reside on the local host. This host name needs to be
+ resolvable using mDNS, consider using <manref
+ name="avahi-publish-address" section="1"/> to register it
+ first.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-d | --domain=</opt> <arg>DOMAIN</arg></p>
+ <optdesc><p>Publish the service in the specified domain. If
+ omited the Avahi daemon will publish it in its default domain
+ (probably .local).</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-h | --help</opt></p>
+ <optdesc><p>Show help</p></optdesc>
+ </option>
+
+ </options>
+
+ <section name="Authors">
+ <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+ available from <url href="@PACKAGE_URL@"/></p>
+ </section>
+
+ <section name="See also">
+ <p>
+ <manref name="avahi-publish-address" section="1"/>, <manref
+ name="avahi-publish-service" section="1"/>, <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>