summaryrefslogtreecommitdiffstats
path: root/doc/man_pages/mmdbresolve.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man_pages/mmdbresolve.adoc')
-rw-r--r--doc/man_pages/mmdbresolve.adoc71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/man_pages/mmdbresolve.adoc b/doc/man_pages/mmdbresolve.adoc
new file mode 100644
index 00000000..af66d6b4
--- /dev/null
+++ b/doc/man_pages/mmdbresolve.adoc
@@ -0,0 +1,71 @@
+include::../attributes.adoc[]
+= mmdbresolve(1)
+:doctype: manpage
+:stylesheet: ws.css
+:linkcss:
+:copycss: {css_dir}/{stylesheet}
+
+== NAME
+
+mmdbresolve - Read IPv4 and IPv6 addresses and print their IP geolocation information.
+
+== SYNOPSIS
+
+[manarg]
+*mmdbresolve*
+*-f <dbfile>*
+[ *-f <dbfile>* ]
+__...__
+
+== DESCRIPTION
+
+*mmdbresolve* reads IPv4 and IPv6 addresses on stdin and prints their IP geolocation information
+on stdout. Each input line must contain exactly one address. Output is in INI format, with a section
+delimiter named after the query address followed by a set of "key: value" pairs. A comment
+beginning with "# End" is appended to each section.
+
+At startup an "[init]" section is printed that shows the status of each datbase and of mmdbresolve
+itself.
+
+== OPTIONS
+
+-f::
+Path to a MaxMind Database file. Multiple databases may be specified.
+
+== EXAMPLES
+
+To resolve a single address:
+
+ echo 4.4.4.4 | mmdbresolve -f /usr/share/GeoIP/GeoLite2-City.mmdb
+
+.Example output
+ [init]
+ db.0.path: /usr/share/GeoIP/GeoLite2-City.mmdb
+ db.0.status: OK
+ mmdbresolve.status: true
+ # End init
+ [4.4.4.4]
+ # GeoLite2-City
+ country.iso_code: US
+ country.names.en: United States
+ location.latitude: 37.751000
+ location.longitude: -97.822000
+ # End 4.4.4.4
+
+== SEE ALSO
+
+xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1)
+
+== NOTES
+
+*mmdbresolve* is part of the *Wireshark* distribution. The latest version
+of *Wireshark* can be found at https://www.wireshark.org.
+
+HTML versions of the Wireshark project man pages are available at
+https://www.wireshark.org/docs/man-pages.
+
+== AUTHORS
+
+.Original Author
+[%hardbreaks]
+Gerald Combs <gerald[AT]wireshark.org>