.\"
.\" Copyright (C) 2003, 2004 Masaki Suzuki. All rights reserved.
.\"
.\" $Id: dnsupdate.8,v 1.10 2004/06/02 11:59:44 masaki Exp $
.\"
.\" This file is free software; as a special exception the author gives
.\" unlimited permission to copy and/or distribute it, with or without
.\" modifications, as long as this notice is preserved.
.\"
.\" This file is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
.\" implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\"
.TH "DNSUPDATE" "8" "Jun  2, 2004"
.SH NAME
dnsupdate \- An automatic IP address updater for dynamic DNS
.SH SYNOPSIS
.PP
\fBdnsupdate\fR [\fIoption\fR]...
.SH "DESCRIPTION"
.PP
\fBDnsupdate\fR
is an IP address update program written in Perl for dynamic DNS updates as
defined in RFC2136.
This program submits dynamic IP address update requests to a name server
automatically.
.PP
\fBDnsupdate\fR
gets a current IP address with a simple cgi program (included in this package)
which is put on an external HTTP server, and it will send update requests to a
name server only if the IP address at the time of the last update is no longer
valid.
.PP
\fBDnsupdate\fR
can be executed as a daemon which repeatedly updates IP addresses for a domain
at a specified interval in the background.
.PP
\fBDnsupdate\fR
can add or delete an address record for a domain manually. And it can also add
or delete an alias for a domain manually.
.SH "OPTIONS"
.PP
.IP "\fB--add \fIaddress\fR"
Add an address record for the target domain manually.
.IP "\fB--del \fIaddress\fR"
Delete an address record for the target domain manually.
.IP "\fB--addalias \fIalias\fR"
Add an alias for the target domain manually.
.IP "\fB--delalias \fIalias\fR"
Delete an alias for the target domain manually.
.IP "\fB-c\fR, \fB--config \fIconfig_file\fR"
Set the configuration file which is used by dnsupdate
instead of the default.
The default configuration file is
`/etc/dnsupdate/dnsupdate.conf'.
.IP "\fB-d\fR, \fB--daemon\fR [\fIinterval\fR]"
Execute dnsupdate as a daemon which updates an address
record for the target domain in the background.
.IP "\fB-debug\fR, \fB--verbose\fR"
Display verbose messages for debugging.
.IP "\fB-f\fR, \fB--force\fR"
Update ignoring the saved IP address, if possible.
.IP "\fB-h\fR, \fB--help\fR"
Display help information and exit.
.IP "\fB-i\fR, \fB--interval \fIinterval\fR"
Set update interval. It overrides the configuration
parameter `INTERVAL'.
The defaults value of `interval' is 600 in seconds.
.IP "\fB-k\fR, \fB--key\fR [\fIkey_name:\fR]\fIkey_file\fR"
Set the key name and the key file. `key_name' and `key_file' override the
configuration parameters `KEY_NAME' and `KEY_FILE'.
`key_name:' is an optional argument. It needs in case a key file contains
only a secret string.
.IP "\fB--kill\fR"
Terminate the daemon process which is running.
.IP "\fB-l\fR, \fB--log\fR [\fIlog_file\fR]"
Log messages to the `log_file'.
`log_file' is an optional argument.
The default log file is `/var/log/dnsupdate.log'.
.IP "\fB-q\fR, \fB--quiet\fR"
Display nothing but stderr.
.IP "\fB--reload\fR"
Reload configurations for the daemon which is running.
.IP "\fB--restart\fR"
Restart the daemon which is running.
.IP "\fB-t\fR, \fB--ttl \fIttl\fR"
Set the ttl. It overrides the configuration parameter
`TTL'.
The defaults value of `ttl' is 600 in seconds.
.IP "\fB-v\fR, \fB--version\fR"
Display version information and exit.
.PP
.SH "FILES"
.TP
\fB\fI/etc/dnsupdate/dnsupdate.conf\fB\fR
The default configuration file.
.TP
\fB\fI/var/run/dnsupdate.pid\fB\fR
The default pid file.
.SH "AUTHOR"
.PP
Masaki Suzuki <masaki@btree.org>
.SH "COPYRIGHT"
.PP
Copyright (C) 2003, 2004 Masaki Suzuki. All rights reserved.