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