summaryrefslogtreecommitdiffstats
path: root/man/avahi-dnsconfd.8.xml.in
blob: 7b09cd4281ac76c1cd7da984813031ec30c52dc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>

<!--
  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-dnsconfd" section="8" desc="Unicast DNS server from mDNS/DNS-SD configuration daemon">

	<synopsis>
      <cmd>avahi-dnsconfd [<arg>options</arg>]</cmd>
      <cmd>avahi-dnsconfd <opt>--kill</opt></cmd>
      <cmd>avahi-dnsconfd <opt>--refresh</opt></cmd>
      <cmd>avahi-dnsconfd <opt>--check</opt></cmd>
	</synopsis>

    <description>
      <p>avahi-dnsconfd connects to a running avahi-daemon and runs
      the script <file>@pkgsysconfdir@/dnsconfd.action</file> for each unicast DNS
      server that is announced on the local LAN. This is useful for
      configuring unicast DNS servers in a DHCP-like fashion with
      mDNS.</p>
	</description>

	<options>

	  <option>
		<p><opt>-D | --daemonize</opt></p>
		<optdesc><p>Daemonize after startup and redirect log messages to syslog.</p></optdesc>
	  </option>

      <option>
        <p><opt>-s | --syslog</opt></p>
        <optdesc><p>Log to syslog instead of STDERR. Implied by <opt>--daemonize</opt>.</p></optdesc>
      </option>

	  <option>
		<p><opt>-k | --kill</opt></p>
		<optdesc><p>Kill an already running avahi-dnsconfd. (equivalent to sending a SIGTERM)</p></optdesc>
	  </option>

	  <option>
		<p><opt>-r | --refresh</opt></p>
		<optdesc><p>Tell an already running avahi-dnsconfd to refresh the DNS server data. (equivalent to sending a SIGHUP)</p></optdesc>
	  </option>

	  <option>
		<p><opt>-c | --check</opt></p>
		<optdesc><p>Return 0 as return code when avahi-dnsconfd is already running.</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="Files">

      <p><file>@pkgsysconfdir@/avahi-dnsconfd.action</file>: the script to run when a DNS server is found or removed.</p>

    </section>

    <section name="Signals">
      <p><arg>SIGINT, SIGTERM</arg>: avahi-dnsconfd will shutdown. This is issued by passing --kill to avahi-daemon.</p>
      <p><arg>SIGHUP</arg>: avahi-dnsconfd will refresh the DNS server data.</p>
    </section>

	<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-daemon" section="8"/>, <manref name="avahi-dnsconfd.action" 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>