Ubuntu Manpage: inadyn — a small DDNS client to maintain your presence on the Internet

Provided by: inadyn_1.99.4-1build1_amd64

NAME

     inadyn — a small DDNS client to maintain your presence on the Internet

SYNOPSIS

     inadyn [-a, --alias ALIAS[,HASH]] [-b, --background] [-B, --bind IFNAME]
            [-d, --drop-privs USER[:GROUP]] [-e, --exec SCRIPT] [-f, --forced-update SEC]
            [-F, --config FILE] [-L, --logfile FILE] [-P, --pidfile FILE] [-c, --cachefile FILE]
            [-s, --syslog] [-h, --help] [-i, --iface IFNAME] [-n, --iterations NUM]
            [-H, --checkip-url SERVER[:PORT] URL] [-N, --server-name SERVER[:PORT]]
            [-U, --server-url PATH] [-S, --system PROVIDER] [-t, --test] [-T, --period SEC]
            [-u, --username USERNAME] [-p, --password PASSWORD] [-v, --version]
            [-V, --verbose LEVEL] [-w, --wildcard] [-x, --proxy-server SERVER[:PORT]]

DESCRIPTION

     inadyn is a client for “open” name servers, also known as DDNS service providers.  That is,
     it lets you have a public Internet name for your DHCP/PPPoE assigned system.  Some of these
     services are free of charge for non-commercial use, others take a small fee, but also
     provide more domains to choose from.

     Common DDNS service providers supported by inadyn:
     •   http://www.dyndns.org
     •   http://freedns.afraid.org
     •   http://zoneedit.com
     •   http://www.no-ip.com
     •   http://www.easydns.com
     •   http://www.tzo.com
     •   http://www.3322.org
     •   http://www.dnsomatic.com
     •   http://www.tunnelbroker.net
     •   http://dns.he.net/
     •   http://www.dynsip.org
     •   http://www.sitelutions.com
     •   http://www.dnsexit.com
     •   http://www.changeip.com

     The basic operation of inadyn is to periodically check whether the actual Internet
     accessible IP of your system is the same one that is recorded in the name server, and update
     the name server records when there is a mismatch.

OPTIONS

-h, --help
Print a summary of the options and exit.

-u, --username USERNAME
The username, if applicable. This might be referred to as hash.

-p, --password PASSWORD
The password, if applicable.

-a, --alias ALIAS
A host name alias. This option can appear multiple times, for each domain that has
the same IP.

-F, --config FILE
The file name that contains inadyn command options exactly as specified in the
command line syntax (adds to those already present on the cmd line). The default
configuration file name, /etc/inadyn.conf, is looked at automatically if inadyn is
called without any command line options. The format is as expected for a UNIX config
file; the hash character is used to comment entire lines. Spaces are ingored. The
long options may be specified without -- if placed at the beginning of the line.

-H, --checkip-url SERVER[:PORT] URL
The client IP is detected by calling URL from this SERVER[:PORT]. Defaults to
http://checkip.dyndns.org.

-N, --server-name SERVER[:PORT]
The server that receives the update DNS requests. When no proxy is specified it is
sufficient to set the --system option so that the default servers will be taken. The
option is useful for generic DynDNS services that support HTTP update.

-U, --server-url PATH
The update path on the DynDNS server.

-S, --system email@ddns-service.tld
DNS service to connect to. Defaults to default@dyndns.org.
default@dyndns.org
http://www.dyndns.org
default@freedns.afraid.org
http://freedns.afraid.org
default@zoneedit.com
http://zoneedit.com
default@no-ip.com
http://www.no-ip.com
default@easydns.com
http://www.easydns.com
default@tzo.com
http://www.tzo.com
dyndns@3322.org
http://www.3322.org
default@dnsomatic.com
http://www.dnsomatic.com
ipv6tb@he.net
http://www.tunnelbroker.net
dyndns@he.net
http://dns.he.net/
default@dynsip.org
http://www.dynsip.org
default@sitelutions.com
http://www.sitelutions.com
default@dnsexit.com
http://www.dnsexit.com
default@changeip.com
http://www.changeip.com
custom@http_svr_basic_auth

-x, --proxy-server SERVER[:PORT]
HTTP proxy server name and port. Default: N/A.

-T, --period SEC
How often the IP is checked, in seconds. Default: apx 1 minute. Max: 10 days.

-f, --forced-update SEC
How often the IP should be updated even if it is not changed. The time should be
given in seconds.

--L, --logfile FILE
The name, including the full path, of a log file. See also the ---syslog option,
below.

-b, --background
Run in background. Output is sent to the UNIX syslog facilities or to a log file, if
one was specified.

-V, --verbose LEVEL
Set the debug level, which is an integer between 0 to 5.

-n, --iterations NUM
Set the number of DNS updates. The default is 0, which means infinity.

-s, --syslog
Use the system syslog(3) mechanism for log messages, warnings and error conditions.

-d, --drop-privs USER[:GROUP]
Drop privileges after initial setup to the given user and group.

-B, --bind IFNAME
Set interface to bind to. Only on UNIX systems.

-i, --iface IFNAME
Set interface to check for IP. Only on UNIX systems. External IP check is not
performed.

-P, --pidfile FILE
Set pidfile, defaults to /var/run/inadyn/inadyn.pid.

-c, --cachefile FILE
Set cachefile, defaults to /var/run/inadyn/inadyn.cache.

-e, --exec SCRIPT
Full path to external command, or script, to run after a successful DDNS update.
SCRIPT can use following environment variables: INADYN_IP, INADYN_HOSTNAME. First
environment variable contains new IP address, second one - host name alias.
INADYN_IFACE is available, if --iface option used.

-w, --wildcard
Enable domain name wildcarding for easydns.com. Default disabled. For inadyn <
1.96.3 wildcarding was enabled by default.

-t, --test
Force one update and quit.

TYPICAL USAGE

   http://www.dyndns.org
     inadyn -u username -p password -a my.registered.name

     inadyn --username username --password password --period 60 --alias test.homeip.net --alias
     my.second.domain

     inadyn --background -u test -p test --period 60 --alias test.homeip.net --alias
     my.second.domain --logfile inadyn_srv.log

   http://freedns.afraid.org
     inadyn --system default@freedns.afraid.org -u username -p password -a my.registrated.name

     inadyn -u username -p password --period 60 --alias test.homeip.net -a my.second.domain
     --system default@freedns.afraid.org

     The “hash” is automatically retrieved by inadyn using freedns API.

OUTPUT

     inadyn prints a message when the IP is updated. If no update is needed then by default it
     prints a single “.” character, unless --verbose is set to 0.  Therefore, unless --verbose is
     set to 0, the log file will contains lot of dots. When the connection goes down it could be
     that inadyn will print some error messages. Those are harmless and should be followed by
     “OK” messages after the connection is back up.

SIGNALS

     inadyn responds to the following signals:

     HUP   Restarts inadyn.  The configuration file is reread every time this signal is evoked.
           It is also useful when a new DHCP/PPPoE lease or new gateway is received. Please note
           that inadyn does not track such events by itself. You need an external monitor for
           that.
     TERM  Terminates inadyn gracefully.
     INT   The same as TERM.
     QUIT  The same as TERM.

     For convenience in sending signals, inadyn writes its process ID to
     /var/run/inadyn/inadyn.pid upon startup.

FILES

     /etc/inadyn.conf
     /var/run/inadyn/inadyn.cache
     /var/run/inadyn/inadyn.pid

AUTHORS

     inadyn was written by Narcis Ilisei <inarcis2002@hotpop.com>, Steve Horbachuk and later
     Joachim Nilsson <troglobit@gmail.com>.

     This manual page was initially written for the Debian GNU/Linux system by Shaul Karl
     <shaul@debian.org>.  Later Joachim Nilsson picked up maintenance.