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