diff --git a/geoip/Makefile.am b/geoip/Makefile.am index 2862ddf..aa28c3d 100644 --- a/geoip/Makefile.am +++ b/geoip/Makefile.am @@ -1,3 +1,5 @@ # -*- Makefile -*- pkglibexec_SCRIPTS = xt_geoip_build xt_geoip_dl + +man1_MANS = xt_geoip_build.1 xt_geoip_dl.1 diff --git a/geoip/xt_geoip_build.1 b/geoip/xt_geoip_build.1 new file mode 100644 index 0000000..a61f92b --- /dev/null +++ b/geoip/xt_geoip_build.1 @@ -0,0 +1,42 @@ +.TH xt_geoip_build 1 "2010-12-17" "xtables-addons" "xtables-addons" +.SH Name +.PP +xt_geoip_build \(em convert GeoIP.csv to packed format for xt_geoip +.SH Syntax +.PP +\fI/usr/libexec/xt_geoip/\fP\fBxt_geoip_build\fP [\fB\-b\fP] [\fB\-D\fP +\fItarget_dir\fP] [\fIfile\fP...] +.SH Description +.PP +xt_geoip_build is used to build packed raw representations of the range +database that the xt_geoip module relies on. Since kernel memory is precious, +much of the preprocessing is done in userspace by this very building tool. One +file is produced for each country, so that no more addresses than needed are +required to be loaded into memory. The ranges in the packed database files are +also ordered, as xt_geoip relies on this property for its bisection approach to +work. +.PP +Input is processed from the listed files, or if none is given, from stdin. +.PP +Since the script is usually installed to the libexec directory of the +xtables-addons package and this is outside $PATH (on purpose), invoking the +script requires it to be called with a path. +.PP Options +.TP +\fB\-b\fP +The packed database files (file extension .iv0) are normally produced in +little-endian format. Use \fB\-b\fP to produce big-endian instead, as is needed +on some CPU families such as MIPS, PPC and SPARC. +.TP +\fB\-D\fP \fItarget_dir\fP +Specify a target directory into which the files are to be put. +.SH Application +.PP +Shell commands to build the databases and put them to where they are expected: +.PP +xt_geoip_build -D /usr/share/xt_geoip/LE +.PP +xt_geoip_build -bD /usr/share/xt_geoip/BE +.SH See also +.PP +xt_geoip_dl(1) diff --git a/geoip/xt_geoip_dl.1 b/geoip/xt_geoip_dl.1 new file mode 100644 index 0000000..3934335 --- /dev/null +++ b/geoip/xt_geoip_dl.1 @@ -0,0 +1,21 @@ +.TH xt_geoip_dl 1 "2010-12-17" "xtables-addons" "xtables-addons" +.SH Name +.PP +xt_geoip_dl \(em download GeoIP database files +.SH Syntax +.PP +\fI/usr/libexec/xt_geoip/\fP\fBxt_geoip_dl\fP +.SH Description +.PP +Downloads and unpacks the MaxMind GeoIP Country Lite databases for IPv4 and +IPv6 and unpacks them to the current directory. +.PP +Since the script is usually installed to the libexec directory of the +xtables-addons package and this is outside $PATH (on purpose), invoking the +script requires it to be called with a path. +.SH Options +.PP +None. +.SH See also +.PP +xt_geoip_build(1)