geoip(3)

📦 version 0.2, in ubuntu jammy

💖 geoip — the Tcl glow-up for IP lookups 💖

okay so bestie, welcome to geoip(3), manual section 3, straight out of Version 0.2 ✨ this is the Tcl extension that does geographic and organisational lookups of IP addresses and hostnames, and she is lowkey iconic.

✨ NAME ✨

geoip — a Tcl extension for geographic or organisational lookup of IP addresses and hostnames. that's it, that's the girl 🫶

🌸 SYNOPSIS 🌸

no cap, here's how you call her:

geoip open [-type TYPE ] [-flags FLAG ]
geoip open [-file PATH ] [-flags FLAG ]
geoip [COMMAND]
geoip [QUERY] arg1

🦋 DESCRIPTION 🦋

this Tcl extension literally wraps up most of the GeoIP C API functions and turns them into Tcl commands. so you get to stay in your cozy Tcl era instead of going full C-mode. she ate 💅

🎀 OPEN OPTIONS 🎀

open takes either a file path plus a set of flags, or a type plus a set of flags. both paths are valid, pick your fighter. supported types and flags live below 👇

  • TYPE — looks under the standard installation share directory, eg /usr/local/share/GeoIP/ for a GeoIP database according to type. it just knows where to look 🧚
  • PATH — absolute or relative path to the GeoIP database. you tell her exactly where it lives.
  • FLAG — flags seperated by ':', eg memory_cache:memory_check. yes, that spelling is the original's, we keep it fr fr 🙈

👑 COMMAND 👑

individual singular commands can be one of:

  • close — close the currently open database. bye bestie, gate closed 🚪
  • db_info — get information about the current database.
  • db_edition — returns edition of opened database.
  • db_avail — test the availability of databases in your system in known locations. e.g db_avail country_edition. she's doing a vibe check on your databases ⭐

🔥 QUERY 🔥

these are the commands that actually query the database. all commands return N/A if a result cannot be found — no drama, just a polite shrug.

also: if none is already open, a command will attempt to open a suitable database on its own. main character energy, she handles it 😌

  • country commands will open a country_edition database.
  • region commands will open a region_edition_rev1 one.
  • name commands will open an org_edition one.
  • the record_edition will open a city_edition_rev1 database.

the commands are:

  • country_code_by_addr — takes an IP address and returns the ISO-3166-1 Alpha-2 code of the country.
  • country_code3_by_addr — takes an IP address and returns the ISO-3166-1 Alpha-3 code the country.
  • country_code_by_name — takes a hostname and returns the ISO-3166-1 Alpha-2 code the country.
  • country_code3_by_name — takes a hostname and returns the ISO-3166-1 Alpha-3 code the country.
  • country_name_by_addr — takes an IP address and returns the country name.
  • country_name_by_name — takes a hostname and returns the country name.
  • name_by_addr — takes an IP address and returns the organisation name (or ISP/ASnum according to the opened database).
  • name_by_name — takes a hostname and returns the organisation name.
  • region_by_addr — takes an IP address and returns these region attributes as in an associative array: country, region.
  • region_by_name — takes a hostname and returns the region attributes.
  • record_by_addr — takes an IP address and returns these record attributes as in an associative array: code, code3, region, country, city, postcode, latitude, longitude, dma (dma code), and area (area code).
  • record_by_name — takes a hostname and returns the record attributes.

🌈 TYPES 🌈

relevant types of databases are: country_edition, org_edition, isp_edition, city_edition_rev1, region_edition_rev1, geoip_asnum_edition.

and here's the slay part: open -type will accept their unambiguous abbreviations. so you don't have to type the whole thing, she gets the vibe 💜

💅 FLAGS 💅

valid flags are: standard, memory_cache, check_cache, index_cache.

🍓 FILES 🍓

  • ./share/GeoIP.dat — GeoIP country_edition database.
  • ./share/GeoIPOrg.dat — GeoIP org_edition database.
  • ./share/GeoIPCity.dat — GeoIP region_city_rev1 database.
  • ./share/GeoIPRegion.dat — GeoIP region_edition_rev1 database.
  • ./share/GeoIPASNum.dat — GeoIP asnum_edition database.

💀 BUGS 💀

please report to author. (not me, not the group chat — the author. go tell them directly bestie 😭)

🫶 AUTHOR 🫶

Djihed Afifi <djihed@gmail.com>.

👀 SEE ALSO 👀

GeoIP C API documentation <www.maxmind.com> — go read the source material, iykyk.

and that's the whole page, periodt. this was geoip(3) from the Tcl extension fam, dated April 2007 — yes she's an elder but she still serves ✨💖🎀 mwah, go do your lookups 🦋

📦 where this page comes from