blob: 2c9c548aa40d11efd4cd2ec0225cf59d3711c334 [file] [log] [blame]
.TH GEOIPUPDATE 1 "14 May 2006"
.UC 4
.SH NAME
geoipupdate - a program for updating the MaxMind GeoIP databases
.SH SYNOPSIS
geoipupdate [-v] [-f licensefile]
.SH DESCRIPTION
geoipupdate automatically updates the GeoIP database for GeoIP
subscribers. It connects to the MaxMind GeoIP Update server
and checks for an updated database. If it finds an updated
database, then it downloads it, uncompresses it, and installs it.
If you are running a firewall, it requires that the DNS and
HTTP (80) ports be open.
.PP
For example
.PP
.I geoipupdate -v
.PP
Performs the update in verbose mode.
.PP
.SH OPTIONS
.IP "-v"
Verbose mode, prints out the steps that geoipupdate takes.
.IP "-f"
Specifies the configuration file that contains the license key.
Defaults to GeoIP.conf in the system configuration directory.
.SH USAGE
Typically you'll want to write a weekly crontab that will run geoipupdate.
Below is a sample crontab that runs geoipupdate on each Wendesday at noon:
.PP
.RS
# top of crontab
.PP
MAILTO=your@email.com
.PP
12 0 * * 3 /usr/local/bin/geoipupdate
.PP
# end of crontab
.RE
.SH RETURN CODES
geoipupdate returns 0 on success, 1 on error.
.SH FILES
.PP
.I CONF_DIR/GeoIP.conf
.PP
Configuration file for GeoIP, should contain license key.
.SH AUTHOR
Written by T.J. Mather
.SH "REPORTING BUGS"
Report bugs to <support@maxmind.com>
.SH COPYRIGHT
Copyright © 2006 MaxMind LLC
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
Visit <http://www.maxmind.com/app/products> to
sign up for a GeoIP subscription.
.PP
geoiplookup(1), crontab(5)