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>
21 <refentrytitle>ddns
</refentrytitle>
22 <manvolnum>1</manvolnum>
26 <refname>ddns
</refname>
27 <refpurpose>Dynamic DNS update client
</refpurpose>
32 <command>ddns
</command>
33 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
34 <arg choice=
"plain">COMMAND
</arg>
39 <title>Description
</title>
42 <command>ddns
</command> is a simple, extensible, cross-distribution,
43 cross-platform dynamic DNS updater written in Python.
48 <title>Options
</title>
51 The following options are understood:
57 <option>-c CONFIG
</option>
60 <option>--config CONFIG
</option>
65 Load the specified configuration file.
66 (Default:
<filename>/etc/ddns/ddns.conf
</filename>)
70 For further details of the config file layout, please consult the
72 <refentrytitle>ddns.conf
</refentrytitle>
73 <manvolnum>5</manvolnum>
85 <option>--debug
</option>
90 Enables the debugging mode.
91 In this mode, there will be debug output on
92 the console and written to the log.
102 <option>--help
</option>
107 Shows the help message provided by the program and exit.
115 <title>Commands
</title>
118 The following commands are understood:
124 <command>update-all
</command>
129 Update all configured dynamic DNS hosts.
136 <command>update
<replaceable>HOSTNAME
</replaceable></command>
141 Perform an update for a single host, specified by the
146 Example:
<command>ddns update somehost.provider.com
</command>
153 <option>--force
</option>
158 When calling an update, the DDNS client automatically checks
159 if this update is required by testing whether the hostname points
160 to the current public IP address. If this test returns true, the call
161 can be droped and no request will be sent to the provider.
165 In cases an update request should be send nevertheless, the update can be
166 forced by using this switch.
170 Example:
<command>ddns update somehost.provider.com --force
</command> or
171 <command>ddns update-all --force
</command>
178 <command>guess-ip-addresses
</command>
183 Try to guess and print the hosts IPv4 and IPv6 addresses
184 based on the choosen method in the used config file.
188 The addresses can be obtained from the system or by
189 help of an external server. For systems behind a NAT the
190 second method is recommended.
194 For further details, please consult the
196 <refentrytitle>ddns.conf
</refentrytitle>
197 <manvolnum>5</manvolnum>
206 <command>list-providers
</command>
211 This command will print out a list of all
212 supported dynamic DNS providers.
216 For details how to add support for new providers,
219 <refentrytitle>ddns-devel
</refentrytitle>
220 <manvolnum>7</manvolnum>
230 <title>Exit Codes
</title>
233 <command>ddns
</command> will normally exit with code
0.
234 If there has been a problem and the requested action could not be done,
235 the exit code is unequal to zero.
243 Please report all bugs to the official bugtracker at
244 http://bugs.ipfire.org/.
249 <title>See Also
</title>
253 <refentrytitle>ddns.conf
</refentrytitle>
254 <manvolnum>5</manvolnum>
257 <refentrytitle>ddns-devel
</refentrytitle>
258 <manvolnum>7</manvolnum>