From 8dce17e2aa5383bb525cdb7e165bff62f33aeb32 Mon Sep 17 00:00:00 2001
From: Fredrik Wahlberg <fredrik@wahlberg.se>
Date: Sun, 25 Jan 2004 22:07:39 +0000
Subject: [PATCH] First draft of a man page, several sections missing and most
 texts are incomplete.

---
 dnsupdate.1 | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 109 insertions(+)
 create mode 100644 dnsupdate.1

diff --git a/dnsupdate.1 b/dnsupdate.1
new file mode 100644
index 0000000..8a090e0
--- /dev/null
+++ b/dnsupdate.1
@@ -0,0 +1,109 @@
+.TH DNSUPDATE 1 
+
+.SH NAME
+.B dnsupdate \fP \- utility written in Python for dynamic hosts to update a nameserver 
+
+.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 nameserver using a TSIG key.
+
+.SS "Requirements"
+Dnsupdate is written in Python and uses the dnspython toolkit which can be found at \fIhttp://www.dnspython.com/\fP.
+
+.SS "Nameserver configuration"
+In order for dnsupdate to work the nameserver 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  \-f force 
+Do not check with the nameserver if the host already has the ip 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 nameserver
+.TP
+.B  \-n hostname
+Hostname of the machine to publish
+.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  \-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. \fB[Not yet implemented]\fP
+.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>