git.meshlink.io Git - catta/blob - man/avahi.service.5.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.service" section="5" desc="avahi-daemon static service file">
  27
  28         <synopsis>
  29       <cmd>@servicedir@/*.service</cmd>
  30         </synopsis>
  31
  32     <description> <p><file>@servicedir@/*.service</file> are XML
  33       fragments containing static DNS-SD service data. Every service
  34       file can contain multiple service definitions which share the
  35       same name. This is useful for publishing service data for
  36       services which implement multiple protocols. (i.e. a printer
  37       implementing _ipp._tcp and _printer.tcp)</p> </description>
  38
  39         <section name="XML Tags">
  40
  41       <option>
  42         <p><opt>&lt;service-group&gt;</opt> The document tag of avahi
  43         service files. Should contain one <opt>&lt;name&gt;</opt> and one or more
  44         <opt>&lt;service&gt;</opt> elements.</p>
  45       </option>
  46
  47       <option>
  48         <p><opt>&lt;name replace-wildcards="yes|no"&gt;</opt> The
  49         service name. If <opt>replace-wildcards</opt> is "yes", any
  50         occurence of the string "%h" will be replaced by the local
  51         host name. This can be used for service names like "Remote
  52         Terminal on %h". If <opt>replace-wildcards</opt> is not
  53         specified, defaults to "no".</p>
  54       </option>
  55
  56       <option>
  57         <p><opt>&lt;service protocol="ipv4|ipv6|any"&gt;</opt>
  58         Contains the service information for exactly one service
  59         type. Should contain one <opt>&lt;type&gt;</opt> and one
  60         <opt>&lt;port&gt;</opt> element. Optionally it may contain one
  61         <opt>&lt;domain-name&gt;</opt>, one
  62         <opt>&lt;host-name&gt;</opt>, any number of
  63         <opt>&lt;subtype&gt;</opt> and any number of
  64         <opt>&lt;txt-record&gt;</opt> elements. The attribute
  65         <opt>protocol</opt> specifies the protocol to advertise the
  66         service on. If <opt>any</opt> is used (which is the default),
  67         the service will be advertised on both IPv4 and IPv6.</p>
  68       </option>
  69
  70       <option>
  71         <p><opt>&lt;type&gt;</opt> Contains the DNS-SD service type for this service. e.g. "_http._tcp".</p>
  72       </option>
  73
  74       <option>
  75         <p><opt>&lt;subtype&gt;</opt> Contains an additional DNS-SD service subtype for this service. e.g. "_anon._sub._ftp._tcp".</p>
  76       </option>
  77
  78       <option>
  79         <p><opt>&lt;domain-name&gt;</opt> The domain name this service
  80         should be registered. If omited defaults to the default domain
  81         of the avahi daemon. (probably .local)</p>
  82       </option>
  83
  84       <option>
  85         <p><opt>&lt;host-name&gt;</opt> The host name of the host that
  86         provides this service. This should be a mDNS resolvable host
  87         name. Please note that you need to specify a fully-qualified
  88         domain name (FQDN) here, i.e. .local is not appended! The host
  89         name needs not to be part of the domain specified in
  90         <opt>&lt;domain-name&gt;</opt>.</p>
  91       </option>
  92
  93       <option>
  94         <p><opt>&lt;port&gt;</opt> The IP port number the service listens on.</p>
  95       </option>
  96
  97       <option>
  98         <p><opt>&lt;txt-record&gt;</opt> DNS-SD TXT record data.</p>
  99       </option>
 100
 101
 102         </section>
 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-daemon" section="8"/>
 112           </p>
 113         </section>
 114
 115         <section name="Comments">
 116           <p>This man page was written using <manref name="xml2man"
 117           section="1" href="http://masqmail.cx/xml2man/"/> by Oliver
 118           Kurth.</p>
 119         </section>
 120
 121   </manpage>