Update man pages for new avahi-publish-* tools

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@990 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe

diff --git a/man/Makefile.am b/man/Makefile.am
index ae83024..f16e8e1 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -31,8 +31,7 @@ man_MANS = \
 
 noinst_DATA = \
        avahi-browse.1.xml \
-       avahi-publish-service.1.xml \
-       avahi-publish-address.1.xml \
+       avahi-publish.1.xml \
        avahi-resolve.1.xml \
        avahi-daemon.8.xml \
        avahi-discover.1.xml \
@@ -49,12 +48,11 @@ if HAVE_DBUS
 
 man_MANS += \
        avahi-browse.1 \
-       avahi-resolve.1
+       avahi-resolve.1 \
+       avahi-publish.1
 
 if HAVE_PYTHON
 man_MANS += \
-       avahi-publish-service.1 \
-       avahi-publish-address.1 \
        avahi-discover.1 \
        avahi-bookmarks.1
 endif
@@ -64,11 +62,7 @@ avahi-browse.1.xml: avahi-browse.1.xml.in Makefile
        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,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
-        -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
-
-avahi-publish-address.1.xml: avahi-publish-address.1.xml.in Makefile
+avahi-publish.1.xml: avahi-publish.1.xml.in Makefile
        sed     -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
         -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
@@ -119,10 +113,7 @@ CLEANFILES += $(man_MANS)
 avahi-browse.1: avahi-browse.1.xml Makefile
        xmltoman $< > $@
 
-avahi-publish-service.1: avahi-publish-service.1.xml Makefile
-       xmltoman $< > $@
-
-avahi-publish-address.1: avahi-publish-address.1.xml Makefile
+avahi-publish.1: avahi-publish.1.xml Makefile
        xmltoman $< > $@
 
 avahi-resolve.1: avahi-resolve.1.xml Makefile
@@ -162,8 +153,7 @@ endif
 EXTRA_DIST = \
        $(man_MANS) \
        avahi-browse.1.xml.in \
-       avahi-publish-service.1.xml.in \
-       avahi-publish-address.1.xml.in \
+       avahi-publish.1.xml.in \
        avahi-resolve.1.xml.in \
        avahi-daemon.8.xml.in \
        avahi-discover.1.xml.in \
@@ -182,9 +172,11 @@ if HAVE_DBUS
 install-exec-local:
        mkdir -p $(DESTDIR)/$(mandir)/man1 && \
                cd $(DESTDIR)/$(mandir)/man1 && \
-               rm -f avahi-resolve-host-name.1 avahi-resolve-address.1 avahi-browse-domains.1 && \
+               rm -f avahi-resolve-host-name.1 avahi-resolve-address.1 avahi-browse-domains.1 avahi-publish-address.1 avahi-publish-service.1 && \
                $(LN_S) avahi-resolve.1 avahi-resolve-host-name.1 && \
                $(LN_S) avahi-resolve.1 avahi-resolve-address.1 && \
-               $(LN_S) avahi-browse.1 avahi-browse-domains.1
+               $(LN_S) avahi-browse.1 avahi-browse-domains.1 && \
+               $(LN_S) avahi-publish.1 avahi-publish-address.1 && \
+               $(LN_S) avahi-publish.1 avahi-publish-service.1
 
 endif

diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in
index 5323317..306152d 100644 (file)
--- a/man/avahi-browse.1.xml.in
+++ b/man/avahi-browse.1.xml.in
@@ -81,18 +81,13 @@
       </option>
 
          <option>
-               <p><opt>-h | --help</opt></p>
-               <optdesc><p>Show help.</p></optdesc>
-         </option>
-
-         <option>
                <p><opt>-r | --resolve</opt></p>
                <optdesc><p>Automatically resolve services found.</p></optdesc>
          </option>
 
          <option>
                <p><opt>-f | --no-fail</opt></p>
-               <optdesc><p>Don't fail if the service is not found running. Instead, wait until it appears. If it disconnects, try to reconnect.</p></optdesc>
+               <optdesc><p>Don't fail if the daemon is not found running. Instead, wait until it appears. If it disconnects, try to reconnect.</p></optdesc>
          </option>
 
          <option>
@@ -101,6 +96,11 @@
          </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>
@@ -114,7 +114,7 @@
        
        <section name="See also">
          <p>
-        <manref name="avahi-publish-service" section="1"/>, <manref name="avahi-daemon" section="8"/>
+        <manref name="avahi-publish" section="1"/>, <manref name="avahi-resolve" section="1"/>, <manref name="avahi-daemon" section="8"/>
          </p>
        </section>
        

diff --git a/man/avahi-publish-address.1.xml.in b/man/avahi-publish-address.1.xml.in
deleted file mode 100644 (file)
index 003f7b2..0000000
--- a/man/avahi-publish-address.1.xml.in
+++ /dev/null
@@ -1,63 +0,0 @@
-<?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-address" section="1" desc="Register an mDNS host name using the Avahi daemon">
-
-       <synopsis>
-      <cmd>avahi-publish-address <arg>name</arg> <arg>address</arg></cmd>
-       </synopsis>
-       
-    <description>
-      <p>Register an mDNS host name to address mapping (and vice versa) using the Avahi daemon.</p>
-       </description>
-       
-       <options>
-
-      <p>Specify a DNS host name (FQDN, e.g. "foobar.local") and an IP
-      address (e.g. "192.168.50.1" or "2001:db8:0:1::1") on the
-      command line.</p>
-         
-       </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-service" section="1"/>, 
-        <manref name="avahi-resolve-address" section="1"/>, 
-        <manref name="avahi-resolve-host-name" 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>

diff --git a/man/avahi-publish-service.1.xml.in b/man/avahi-publish-service.1.xml.in
deleted file mode 100644 (file)
index c4bbd12..0000000
--- a/man/avahi-publish-service.1.xml.in
+++ /dev/null
@@ -1,84 +0,0 @@
-<?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-publish-service [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg></cmd>
-      <cmd>avahi-publish-service <opt>--help</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-browse" 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>

diff --git a/man/avahi-publish.1.xml.in b/man/avahi-publish.1.xml.in
new file mode 100644 (file)
index 0000000..cab5828
--- /dev/null
+++ b/man/avahi-publish.1.xml.in
@@ -0,0 +1,124 @@
+<?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 or host name or address mapping using the Avahi daemon">
+
+       <synopsis>
+      <cmd>avahi-publish -s [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg> [<arg>TXT data</arg> ...]</cmd>
+      <cmd>avahi-publish-service [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg> [<arg>TXT data</arg> ...]</cmd>
+      <cmd>avahi-publish -a [<arg>options</arg>] <arg>host name</arg> <arg>address</arg></cmd>
+      <cmd>avahi-publish-address [<arg>options</arg>] <arg>host name</arg> <arg>address</arg></cmd>
+       </synopsis>
+       
+    <description>
+      <p>Register an mDNS/DNS-SD service or host name/address mapping using the Avahi daemon.</p>
+       </description>
+       
+       <options>
+
+      <p>When calling in service registration mode, 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,
+      optionally followed by any number of TXT record strings on the
+      command line. When calling in address/host name registration
+      mode specify a fully qualified host name and an address (IPv4 or
+      IPv6).</p>
+         
+         <option>
+        <p><opt>-s | --service</opt></p>
+        <optdesc><p>Register a service. avahi-publish-service is equivalent to avahi-publish -s.</p></optdesc>
+      </option>
+
+         <option>
+        <p><opt>-a | --address</opt></p>
+        <optdesc><p>Register an address/host name maping. avahi-publish-address is equivalent to avahi-publish -a.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>-v | --verbose</opt></p>
+        <optdesc><p>Enable verbose mode.</p></optdesc>
+      </option>
+
+      <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
+               fully qualified and resolvable using mDNS or unicast
+               DNS.</p></optdesc>
+         </option>
+
+         <option>
+               <p><opt>-d | --domain=</opt> <arg>DOMAIN</arg></p>
+        <optdesc><p>Publish the service in the specified domain. If
+        omitted the Avahi daemon will publish it in its default domain
+        (usually .local).</p></optdesc>
+         </option>
+
+      <option>
+        <p><opt>--subtype=</opt> <arg>SUBTYPE</arg></p>
+        <optdesc><p>Register the service with an additional subtype in
+        addition to the main type. DNS-SD subtypes  have the form
+        _anon._sub._ftp._tcp, where _anon is the identifier of the
+        subtype and _ftp._tcp is the main type. You may pass this
+        option multiple times to register the service with multiple
+        subtypes.</p></optdesc>
+      </option>
+
+         <option>
+               <p><opt>-f | --no-fail</opt></p>
+               <optdesc><p>Don't fail if the daemon is not found running. Instead, wait until it appears. If it disconnects, try to reconnect.</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="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-resolve" section="1"/>, <manref
+        name="avahi-browse" 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>