.TH DNSUPDATE 1 

.SH NAME
.B dnsupdate \fP \- Updates a name server using a TSIG key

.SH SYNOPSIS
.B dnsupdate\fp [ \fIoptions\fR ... ]

.SH "DESCRIPTION"
Dnsupdate is a utility to let a host with a dynamic IP address securely update it's master name server using a TSIG key.

.SS "Requirements"
Dnsupdate is written in Python and requires Python > 2.0 to be installed. 

The client systems time must match the servers time in order for the TSIG keys to work.

It also uses the dnspython toolkit which can be found at \fIhttp://www.dnspython.com/\fP.

If a Python version before 2.3 is used the Optik toolkit is required. It provides parsing of command line paramters and can be found at \fihttp://optik.sourceforge.net/\fP.

.SS "Name Server configuration"
In order for dnsupdate to work the name server must be configured to allow dynamic updates using a TSIG key. 

.SH OPTIONS
.TP
.B \-c \-\-config <path to config file>
alternative config file 
.TP
.B \-\-delete
Remove the host from the zone
.TP 
.B \-d \-\-domain <i.e. example.com>
The domain to update
.TP
.B \-\-force 
Do not check with the name server if the host already has the IP address information, just send the update
.TP
.B  \-h \-\-help
Print a help message and exit
.TP
.B  \-i \-\-ipaddress
The public IP address of this machine
.TP
.B  \-k \-\-keyname
The name of the key used to authenticate with the name server
.TP
.B  \-n \-\-hostname
Hostname of the machine to publish
.TP
.B  \-\-nameserver
IP address of the master nameserver to query
.TP
.B  \-q quiet
Quiet mode, do not print any output to the console
.TP
.B  \-s \-\-keysecret
The TSIG password
.TP
.B  \-\-showcfg 
Print the values in the configuration file and then exit
.TP
.B  \-t \-\-ttl
Time To Live in seconds. The number of seconds the hostname is valid before it is re-checked
.TP
.B  \-u \-\-ipurl
The url to a webpage which returns your public IP address
.TP
.B  \-v \-\-verbose
Verbose mode, prints progress information

.SH "RETURN VALUE"
Returns 0 if successful.

.SH ERRORS
Returns 1 if an error occurred.

.SH EXAMPLES
To call dnsupdate from a script during bootup. (Assumes you have a valid \fI/etc/dnsupdaterc\fP):
.IP 
dnspython -q
.P
To remove an old hostname you no longer wish to publish:
.IP
dnspython --delete -n oldhostname

.SH ENVIRONMENT
envariables this program might care about
.SH FILES
.I 
/etc/dnsupdaterc
.RS
The system wide configuration file, see \fIdnsupdaterc(5)\fP for details.
.RE
.I
~/.dnsupdaterc
.RS
The per user configuration file, see \fIdnsupdaterc(5)\fP for details.

.SH "SEE ALSO"
\fIdnsupdaterc(5)\fP for details on how to write a configuration file

.SH NOTES
Stuff they might want to know

.SH CAVEATS
Why shit normally breaks

.SH DIAGNOSTICS
All the errors reported and why they occur

There is a bug in dnspython 1.2.0 under Windows which can be patched. If you get an error about timeouts this might be the case.

.SH BUGS
Report bugs to <dnsupdate-bugs@wahlis.com>.

.SH RESTRICTIONS
bugs I don't plan to fix :-)

.SH AUTHOR
Fredrik Wahlberg
\fI<fredrik@wahlis.com>