man/location.txt

   1 = location(8)
   2
   3 == NAME
   4 location - Query the location database
   5
   6 == SYNOPSIS
   7 [verse]
   8 `location export --directory=DIR [--format=FORMAT] [--family=ipv6|ipv4] [ASN|CC ...]`
   9 `location get-as ASN [ASN...]`
  10 `location list-countries [--show-name] [--show-continent]`
  11 `location list-networks-by-as ASN`
  12 `location list-networks-by-cc COUNTRY_CODE`
  13 `location list-networks-by-flags [--anonymous-proxy|--satellite-provider|--anycast|--drop]`
  14 `location lookup ADDRESS [ADDRESS...]`
  15 `location search-as STRING`
  16 `location update [--cron=daily|weekly|monthly]`
  17 `location verify`
  18 `location version`
  19
  20 == DESCRIPTION
  21 `location` retrieves information from the location database.
  22 This data can be used to determine someone's location on the Internet
  23 and for building firewall rulesets to block access from certain ASes
  24 or countries.
  25
  26 == OPTIONS
  27
  28 --database FILE::
  29 -d FILE::
  30         The path of the database which is being opened.
  31         +
  32         If this option is omitted, the system's database will be opened.
  33
  34 --quiet::
  35         Enable quiet mode
  36
  37 --debug::
  38         Enable debugging mode
  39
  40 == COMMANDS
  41
  42 'export --directory=DIR [--format=FORMAT] [--family=ipv6|ipv4] [ASN|CC ...]'::
  43         This command exports the whole database into the given directory.
  44         +
  45         The output can be filtered by only exporting a certain address family, or by passing
  46         a list of country codes and/or ASNs. The default is to export all known countries.
  47         +
  48         The output format can be chosen with the '--format' parameter. For possible formats,
  49         please see below.
  50
  51 'get-as ASN [ASN...]'::
  52         This command returns the name of the owning organisation of the Autonomous
  53         System.
  54
  55 'list-countries [--show-name] [--show-continent]'::
  56         Lists all countries known to the database.
  57         +
  58         With the optional parameters '--show-name' and '--show-continent', the name and
  59         continent code will be printed, too.
  60
  61 'list-networks-by-as [--family=[ipv6|ipv4]] [--format=FORMAT] ASN'::
  62         Lists all networks which belong to this Autonomous System.
  63         +
  64         The '--family' parameter can be used to filter output to only IPv6 or
  65         IPv4 addresses.
  66         +
  67         The '--format' parameter can change the output so that it can be
  68         directly loaded into other software. For details see below.
  69
  70 'list-networks-by-cc [--family=[ipv6|ipv4]] [--format=FORMAT] COUNTRY_CODE'::
  71         Lists all networks that belong to a country.
  72         +
  73         The country has to be encoded in ISO3166 Alpha-2 notation.
  74         +
  75         See above for usage of the '--family' and '--format' parameters.
  76
  77 'list-networks-by-flags [--family=[ipv6|ipv4]] [--format=FORMAT] [--anonymous-proxy|--satellite-provider|--anycast|--drop]'::
  78         Lists all networks that have a certain flag.
  79         +
  80         See above for usage of the '--family' and '--format' parameters.
  81
  82 'list-bogons [--family=[ipv6|ipv4]] [--format=FORMAT]'::
  83         Lists all bogons (i.e. networks that are unknown to the database).
  84         +
  85         See above for usage of the '--family' and '--format' parameters.
  86
  87 'lookup ADDRESS [ADDRESS...]'::
  88         This command returns the network the given IP address has been found in
  89         as well as its Autonomous System if that information is available.
  90
  91 'search-as STRING'::
  92         Lists all Autonomous Systems which match the given string.
  93         +
  94         The search will be performed case-insensitively.
  95
  96 'update'::
  97         This command will try to update the local database.
  98         +
  99         It will terminate with a return code of zero if the database has been
 100         successfully updated. 1 on error, 2 on invalid call and 3 if the
 101         database was already the latest version.
 102         +
 103         The '--cron' option allows limiting updates to once a day ('daily'), once a week
 104         ('weekly'), or once a month ('monthly'). If the task is being called, but the
 105         database has been updated recently, an update will be skipped.
 106
 107 'verify'::
 108         Verifies the downloaded database.
 109
 110 'version'::
 111         Shows the version information of the downloaded database.
 112
 113 '--help'::
 114         Shows a short help text on using this program.
 115
 116 '--version'::
 117         Shows the program's version and exists.
 118
 119 == EXIT CODES
 120 The 'location' command will normally exit with code zero.
 121 If there has been a problem and the requested action could not be performed,
 122 the exit code is unequal to zero.
 123
 124 == FORMATS
 125 Some commands allow specifying the output format. This is helpful if the exported
 126 data should be imported into a packet filter for example.
 127 The following formats are understood:
 128
 129         * 'list' (default): Just lists all networks, one per line
 130         * 'ipset': For ipset
 131         * 'nftables': For nftables
 132         * 'xt_geoip': Returns a list of networks to be loaded into the
 133           xt_geoip kernel module
 134
 135 == HOW IT WORKS
 136 The downloader checks a DNS record for the latest version of the database.
 137 It will then try to download a file with that version from a mirror server.
 138 If the downloaded file is outdated, the next mirror will be tried until we
 139 have found a file that is recent enough.
 140
 141 == BUG REPORTS
 142 Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/;
 143 refer to https://wiki.ipfire.org/devel/bugzilla for details.
 144
 145 == AUTHORS
 146 Michael Tremer