git.meshlink.io Git - catta/blob - avahi-publish.1.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8   This file is part of avahi.
   9
  10   avahi is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as
  12   published by the Free Software Foundation; either version 2.1 of the
  13   License, or (at your option) any later version.
  14
  15   avahi is distributed in the hope that it will be useful, but WITHOUT
  16   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18   Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public
  21   License along with avahi; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 -->
  25
  26   <manpage name="avahi-publish-service" section="1" desc="Register an mDNS/DNS-SD service or host name or address mapping using the Avahi daemon">
  27
  28         <synopsis>
  29       <cmd>avahi-publish -s [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg> [<arg>TXT data</arg> ...]</cmd>
  30       <cmd>avahi-publish-service [<arg>options</arg>] <arg>name</arg> <arg>service-type</arg> <arg>port</arg> [<arg>TXT data</arg> ...]</cmd>
  31       <cmd>avahi-publish -a [<arg>options</arg>] <arg>host name</arg> <arg>address</arg></cmd>
  32       <cmd>avahi-publish-address [<arg>options</arg>] <arg>host name</arg> <arg>address</arg></cmd>
  33         </synopsis>
  34
  35     <description>
  36       <p>Register an mDNS/DNS-SD service or host name/address mapping using the Avahi daemon.</p>
  37         </description>
  38
  39         <options>
  40
  41       <p>When calling in service registration mode, specify a DNS-SD
  42       service name (e.g. "Lennart's Files"), a service type
  43       (e.g. _http._tcp) and an IP port number for the service,
  44       optionally followed by any number of TXT record strings on the
  45       command line. When calling in address/host name registration
  46       mode specify a fully qualified host name and an address (IPv4 or
  47       IPv6).</p>
  48
  49           <option>
  50         <p><opt>-s | --service</opt></p>
  51         <optdesc><p>Register a service. avahi-publish-service is equivalent to avahi-publish -s.</p></optdesc>
  52       </option>
  53
  54           <option>
  55         <p><opt>-a | --address</opt></p>
  56         <optdesc><p>Register an address/host name maping. avahi-publish-address is equivalent to avahi-publish -a.</p></optdesc>
  57       </option>
  58
  59       <option>
  60         <p><opt>-v | --verbose</opt></p>
  61         <optdesc><p>Enable verbose mode.</p></optdesc>
  62       </option>
  63
  64       <option>
  65                 <p><opt>-H | --host=</opt> <arg>HOSTNAME</arg></p>
  66                 <optdesc><p>Specify a host name for this service, in case it
  67                 doesn't reside on the local host. This host name needs to be
  68                 fully qualified and resolvable using mDNS or unicast
  69                 DNS.</p></optdesc>
  70           </option>
  71
  72           <option>
  73                 <p><opt>-d | --domain=</opt> <arg>DOMAIN</arg></p>
  74         <optdesc><p>Publish the service in the specified domain. If
  75         omitted the Avahi daemon will publish it in its default domain
  76         (usually .local).</p></optdesc>
  77           </option>
  78
  79       <option>
  80         <p><opt>--subtype=</opt> <arg>SUBTYPE</arg></p>
  81         <optdesc><p>Register the service with an additional subtype in
  82         addition to the main type. DNS-SD subtypes  have the form
  83         _anon._sub._ftp._tcp, where _anon is the identifier of the
  84         subtype and _ftp._tcp is the main type. You may pass this
  85         option multiple times to register the service with multiple
  86         subtypes.</p></optdesc>
  87       </option>
  88
  89           <option>
  90                 <p><opt>-f | --no-fail</opt></p>
  91                 <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>
  92           </option>
  93
  94           <option>
  95                 <p><opt>-h | --help</opt></p>
  96                 <optdesc><p>Show help</p></optdesc>
  97           </option>
  98
  99           <option>
 100                 <p><opt>-V | --version</opt></p>
 101                 <optdesc><p>Show version information.</p></optdesc>
 102           </option>
 103
 104         </options>
 105
 106         <section name="Authors">
 107           <p>The Avahi Developers &lt;@PACKAGE_BUGREPORT@&gt;; Avahi is
 108           available from <url href="@PACKAGE_URL@"/></p>
 109         </section>
 110
 111         <section name="See also">
 112           <p>
 113         <manref name="avahi-resolve" section="1"/>, <manref
 114         name="avahi-browse" section="1"/>, <manref
 115         name="avahi-daemon" section="8"/>
 116           </p>
 117         </section>
 118
 119         <section name="Comments">
 120           <p>This man page was written using <manref name="xml2man" section="1"
 121                   href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
 122         </section>
 123
 124   </manpage>