2 <!DOCTYPE refentry PUBLIC
"-//OASIS/DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
8 <productname>ddns
</productname>
12 <contrib>Developer
</contrib>
13 <firstname>Stefan
</firstname>
14 <surname>Schantl
</surname>
15 <email>stefan.schantl@ipfire.org
</email>
19 <contrib>Developer
</contrib>
20 <firstname>Michael
</firstname>
21 <surname>Tremer
</surname>
22 <email>michael.tremer@ipfire.org
</email>
28 <refentrytitle>ddns
</refentrytitle>
29 <manvolnum>1</manvolnum>
33 <refname>ddns
</refname>
34 <refpurpose>Dynamic DNS update client
</refpurpose>
39 <command>ddns
</command>
40 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
41 <arg choice=
"plain">COMMAND
</arg>
46 <title>Description
</title>
49 <command>ddns
</command> is a simple, extensible, cross-distribution,
50 cross-platform dynamic DNS updater written in Python.
55 <title>Options
</title>
58 The following options are understood:
64 <option>-c CONFIG
</option>
67 <option>--config CONFIG
</option>
72 Load the specified configuration file.
73 (Default:
<filename>/etc/ddns/ddns.conf
</filename>)
77 For further details of the config file layout, please consult the
79 <refentrytitle>ddns.conf
</refentrytitle>
80 <manvolnum>5</manvolnum>
92 <option>--debug
</option>
97 Enables the debugging output.
107 <option>--help
</option>
112 Shows the help message provided by the program and exit.
120 <title>Commands
</title>
123 The following commands are understood:
130 <command>update
<option>[--force]
</option> <replaceable>HOSTNAME
</replaceable></command>
135 Perform an update for a single host, specified by the
140 When calling an update, the DDNS client automatically checks
141 if this update is required by testing whether the hostname points
142 to the current public IP address.
143 Therefore it is not guaranteed than an update is performed.
147 The
<option>--force
</option> switch can be used to skip that
148 check and perform an update. Please note that some providers
149 may block your account if unnecessary updates are repeatedly
157 <command>update-all
<option>[--force]
</option></command>
162 Update all configured dynamic DNS hosts when an update is necessary.
166 The
<option>--force
</option> switch has the same effect as
167 with the
<command>update
</command> command.
174 <command>guess-ip-addresses
</command>
179 Guesses the public IPv6 and IPv4 addresses with help of an
180 external server and prints them on the conole.
187 <command>list-providers
</command>
192 This command will print out a list of all
193 supported dynamic DNS providers.
201 <title>Exit Codes
</title>
204 <command>ddns
</command> will normally exit with code
0.
205 If there has been a problem and the requested action could not be done,
206 the exit code is unequal to zero.
214 Please report all bugs to the official bugtracker at
215 http://bugs.ipfire.org/.
220 <title>See Also
</title>
224 <refentrytitle>ddns.conf
</refentrytitle>
225 <manvolnum>5</manvolnum>