From a304572b7b3d4dda673fc7a0fda72248bbba4e2d Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 18 Apr 2024 18:29:56 -0400 Subject: [PATCH] doc/man1/geoipyupdate.1: new man page --- MANIFEST.in | 1 + doc/man1/geoipyupdate.1 | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 doc/man1/geoipyupdate.1 diff --git a/MANIFEST.in b/MANIFEST.in index 38df4da..3bef729 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,3 @@ include doc/geoipyupdate-sample.toml +include doc/man1/geoipyupdate.1 include LICENSE diff --git a/doc/man1/geoipyupdate.1 b/doc/man1/geoipyupdate.1 new file mode 100644 index 0000000..7506089 --- /dev/null +++ b/doc/man1/geoipyupdate.1 @@ -0,0 +1,35 @@ +.TH geoipyupdate 1 + +.SH NAME +geoipyupdate \- Simple python replacement for the MaxMind +geoipupdate program +.SH SYNOPSIS + +\fBgeoipyupdate\fR [\fB\-h\fR] [\fB\-\-config\-file FILE\fR] +.SH DESCRIPTION + +If you know what MaxMind's geoipupdate program does, then you know +what geoipyupdate does, because they do the same thing. And if you +don't know what MaxMind's geoipupdate does, then you're probably in +the wrong place. + +To use geoipyupdate, edit the sample config file, put it someplace, +and then run geoipyupdate using the \fI\-\-config\-file\fR option to +tell it where your config file lives. That's pretty much it. +.SH OPTIONS + +.IP \fB\-\-config\-file\fR,\ \fB\-c\fR +Use the given configuration file instead of the default. +.IP \fB\-\-help\fR,\ \fB-h\fR +Display usage information. + +.SH EXAMPLES +.IP \[bu] 2 +Use a non-default config file location: + +.nf +.I $ geoipyupdate -c /etc/geoipyupdate.toml +.fi +.SH BUGS +.P +Send bugs to michael@orlitzky.com. -- 2.43.2