.\" Text automatically generated by txt2man
.TH ipcheck 8 "15 Oct 2016" "ipcheck-0.233" "Dyndns.org client to register your dynamic IP address"
.SH NAME
\fBipcheck \fP- Dyndns.org client to register your dynamic IP address
\fB
.SH SYNOPSIS
.nf
.fam C
\fBipcheck\fP [\fIoptions\fP] \fIUsername\fP \fIPassword\fP \fIHostnames\fP
\fBipcheck\fP [\fIoptions\fP] \fB--acctfile\fP \fIacct_info_file\fP

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBipcheck\fP is a simple Python script to register your dynamic IP address using the NIC V2.0 protocol.
It aim to be fully compliant with the dyndns client specification.
.PP
The script is very easy to use and supports multiple methods for determining the external IP (parsing
interfaces on the local machine, web based IP detection, direct support for devices from Linksys,
Netgear, Draytek, Netopia, HawkingTech, Watchgard, Cayman, Nexland, ZyXEL, SMC, Compex, UgatePlus,
DLink and Cisco).
.PP
Run the script with no command line arguments for quick start instructions.
.SH OPTIONS
.TP
.B
\fB-a\fP address
Manually specify the address.
.TP
.B
\fB-r\fP URL
NAT router, use web IP detection.
.TP
.B
\fB-A\fP text
Scan syslog for an IP after text (Unix only).
.TP
.B
\fB-F\fP filename
Guess the WAN IP from a firewall log.
.TP
.B
\fB-b\fP
Backup mx option ON (default OFF).
.TP
.B
\fB-c\fP
Custom dns option (default dynamic).
.TP
.B
\fB-d\fP dir
Directory for data files (default current).
.TP
.B
\fB-e\fP script
Execute script after a successful update.
.TP
.B
\fB-f\fP
Force update regardless of current state.
.TP
.B
\fB-g\fP
NAT router, let dyndns guess your IP.
(do not use this in a cronjob, try \fB-r\fP).
.TP
.B
\fB-h\fP
Print this help text.
.TP
.B
\fB--help\fP
Print all available help text.
.TP
.B
\fB-i\fP interface
Interface for local address (default ppp0).
.TP
.B
\fB-j\fP
Disable https.
.TP
.B
\fB-l\fP
Log debugging text to ipcheck.log file.
.TP
.B
\fB--syslog\fP
Log debugging text to syslog (Unix only).
.TP
.B
\fB-m\fP mxhost
MX host (default NOCHG).
.TP
.B
\fB-o\fP
Set dyndns offline mode.
.TP
.B
\fB-p\fP
Proxy bypass on port 8245.
.TP
.B
\fB-q\fP
Quiet mode (unless there is an error).
.TP
.B
\fB-s\fP
Static dns option (default dynamic).
.TP
.B
\fB-t\fP
Test run, do not send the update.
.TP
.B
\fB-v\fP
Verbose mode.
.TP
.B
\fB-w\fP
Wildcard mode ON (default OFF).
.TP
.B
\fB--makedat\fP
Create the ipcheck.dat file by dns lookup.
.TP
.B
\fB--devices\fP
Print router \fIoptions\fP (Linksys, Netgear, etc).
.TP
.B
\fB-n\fP ip
The router IP address on the internal lan.
.SH OTHER OPTIONS
.IP \(bu 3
For help with different \fIoptions\fP: \fBipcheck\fP \fB-h\fP
.IP \(bu 3
For supported devices listing: \fBipcheck\fP \fB--devices\fP
.IP \(bu 3
For long detailed help text: \fBipcheck\fP \fB--help\fP
.SH EXAMPLES
Example 1: the external IP is on eth0 of the current machine:
.PP
.nf
.fam C
    # ipcheck -l -i eth0 username password hostnames

.fam T
.fi
Example 2: you are using the Linksys routing device:
.PP
.nf
.fam C
    # ipcheck -l -L linksyspassword username password hostnames

.fam T
.fi
Example 3: you want to use web based ip detection:
.PP
.nf
.fam C
    # ipcheck -l -r checkip.dyndns.org:8245 \.\.\.

.fam T
.fi
where \.\.\. is your dyndns username password and hostnames.
\fIHostnames\fP should be comma delimited if there are more than one.
.SH AUTHOR
\fBipcheck\fP was written by Kal <kal@users.sourceforge.net>.
.PP
This manual page was written by Joao Eriberto Mota Filho <eriberto@debian.org>
for Debian project (but may be used by others).