From 7bf32698e89c1c3abdf0bd76fd3cec4f86a8e622 Mon Sep 17 00:00:00 2001 From: Stefan Schantl Date: Sun, 27 Jul 2014 21:26:25 +0200 Subject: [PATCH] Add ddns.1 manpage. --- man/ddns.xml | 262 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 man/ddns.xml diff --git a/man/ddns.xml b/man/ddns.xml new file mode 100644 index 0000000..05f429a --- /dev/null +++ b/man/ddns.xml @@ -0,0 +1,262 @@ + + + + + + ddns + ddns + + + + Developer + Stefan + Schantl + stefan.schantl@ipfire.org + + + + + + ddns + 1 + + + + ddns + Dynamic DNS update client + + + + + ddns + OPTIONS + COMMAND + + + + + Description + + + ddns is a simple, extensible, cross-distribution, + cross-platform dynamic DNS updater written in Python. + + + + + Options + + + The following options are understood: + + + + + + + + + + + + + + Load the specified configuration file. + (Default: /etc/ddns/ddns.conf) + + + + For further details of the config file layout, please consult the + + ddns.conf + 5 + + manual page. + + + + + + + + + + + + + + + Enables the debugging mode. + In this mode, there will be debug output on + the console and written to the log. + + + + + + + + + + + + + + + Shows the help message provided by the program and exit. + + + + + + + + Commands + + + The following commands are understood: + + + + + + update-all + + + + + Update all configured dynamic DNS hosts. + + + + + + + update HOSTNAME + + + + + Perform an update for a single host, specified by the + given hostname. + + + + Example: ddns update somehost.provider.com + + + + + + + + + + + + When calling an update, the DDNS client automatically checks + if this update is required by testing whether the hostname points + to the current public IP address. If this test returns true, the call + can be droped and no request will be sent to the provider. + + + + In cases an update request should be send nevertheless, the update can be + forced by using this switch. + + + + Example: ddns update somehost.provider.com --force or + ddns update-all --force + + + + + + + guess-ip-addresses + + + + + Try to guess and print the hosts IPv4 and IPv6 addresses + based on the choosen method in the used config file. + + + + The addresses can be obtained from the system or by + help of an external server. For systems behind a NAT the + second method is recommended. + + + + For further details, please consult the + + ddns.conf + 5 + + manual page. + + + + + + + list-providers + + + + + This command will print out a list of all + supported dynamic DNS providers. + + + + For details how to add support for new providers, + please consult the + + ddns-devel + 7 + + manual page. + + + + + + + + Exit Codes + + + ddns will normally exit with code 0. + If there has been a problem and the requested action could not be done, + the exit code is unequal to zero. + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugs.ipfire.org/. + + + + + See Also + + + + ddns.conf + 5 + , + + ddns-devel + 7 + + + + -- 2.39.2