doc/mmdbresolve.pod

   1 =begin man
   2
   3 =encoding utf8
   4
   5 =end man
   6
   7 =head1 NAME
   8
   9 mmdbresolve - Read IPv4 and IPv6 addresses and print their IP geolocation information.
  10
  11 =head1 SYNOPSIS
  12
  13 B<mmdbresolve>
  14 S<B<-f E<lt>dbfileE<gt>>>
  15 S<[ B<-f E<lt>dbfileE<gt>> ]>
  16 I<...>
  17
  18 =head1 DESCRIPTION
  19
  20 B<mmdbresolve> reads IPv4 and IPv6 addresses on stdin and prints their IP geolocation information
  21 on stdout. Each input line must contain exactly one address. Output is in INI format, with a section
  22 delimiter named after the query address followed by a set of "key: value" pairs. A comment
  23 beginning with "# End" is appended to each section.
  24
  25 At startup an "[init]" section is printed that shows the status of each datbase and of mmdbresolve
  26 itself.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item -f
  33
  34 Path to a MaxMind Database file. Multiple databases may be specified.
  35
  36 =back
  37
  38 =head1 EXAMPLES
  39
  40 To resolve a single address:
  41
  42     echo 4.4.4.4 | mmdbresolve -f /usr/share/GeoIP/GeoLite2-City.mmdb
  43
  44   Example output:
  45 [init]
  46 db.0.path: /usr/share/GeoIP/GeoLite2-City.mmdb
  47 db.0.status: OK
  48 mmdbresolve.status: true
  49 # End init
  50 [4.4.4.4]
  51 # GeoLite2-City
  52 country.iso_code: US
  53 country.names.en: United States
  54 location.latitude: 37.751000
  55 location.longitude: -97.822000
  56 # End 4.4.4.4
  57
  58 =head1 SEE ALSO
  59
  60 wireshark(1), tshark(1)
  61
  62 =head1 NOTES
  63
  64 B<mmdbresolve> is part of the B<Wireshark> distribution. The latest version
  65 of B<Wireshark> can be found at L<https://www.wireshark.org>.
  66
  67 HTML versions of the Wireshark project man pages are available at:
  68 L<https://www.wireshark.org/docs/man-pages>.
  69
  70 =head1 AUTHORS
  71
  72   Original Author
  73   ---------------
  74   Gerald Combs            <gerald[AT]wireshark.org>