X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/381aecb95231afa04dd41da7ece3533aa525c3fa..d1e7b85cc5871a79d808634586d4425466bb2333:/man/nominatim.1 diff --git a/man/nominatim.1 b/man/nominatim.1 index a26861ff..94fc989c 100644 --- a/man/nominatim.1 +++ b/man/nominatim.1 @@ -3,13 +3,18 @@ nominatim .SH SYNOPSIS .B nominatim -[-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status} ... +[-h] [--version] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,convert,serve,search,reverse,lookup,details,status} ... .SH DESCRIPTION Command\-line tools for importing, updating, administrating and +.br querying the Nominatim database. +.br .SH OPTIONS +.TP +\fB\-\-version\fR +Print Nominatim version and exit .SS \fBSub-commands\fR @@ -39,13 +44,16 @@ nominatim Analyse and maintain the database. .TP \fBnominatim\fR \fI\,export\/\fR - Export addresses as CSV file from the database. + Export places as CSV file from the database. +.TP +\fBnominatim\fR \fI\,convert\/\fR + Convert an existing database into a different format. (EXPERIMENTAL) .TP \fBnominatim\fR \fI\,serve\/\fR Start a simple web server for serving the API. .TP \fBnominatim\fR \fI\,search\/\fR - Execute API search query. + Execute a search query. .TP \fBnominatim\fR \fI\,reverse\/\fR Execute API reverse query. @@ -57,15 +65,26 @@ nominatim Execute API details query. .TP \fBnominatim\fR \fI\,status\/\fR - Execute API status query. + .SH OPTIONS 'nominatim import' usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - (--osm-file FILE | --continue {load-data,indexing,db-postprocess}) + [--osm-file FILE] + [--continue {import-from-file,load-data,indexing,db-postprocess}] [--osm2pgsql-cache SIZE] [--reverse-only] - [--no-partitions] [--no-updates] [--ignore-errors] - [--index-noanalyse] + [--no-partitions] [--no-updates] [--offline] + [--ignore-errors] [--index-noanalyse] + [--prepare-database] Create a new Nominatim database from an OSM file. +.br + +.br + This sub\-command sets up a new Nominatim database from scratch starting +.br + with creating a new database in Postgresql. The user running this command +.br + needs superuser rights on the database. +.br @@ -88,10 +107,10 @@ Number of parallel threads to use .TP \fB\-\-osm\-file\fR FILE -OSM file to be imported. +OSM file to be imported (repeat for importing multiple files) .TP -\fB\-\-continue\fR {load\-data,indexing,db\-postprocess} +\fB\-\-continue\fR {import\-from\-file,load\-data,indexing,db\-postprocess} Continue an import that was interrupted .TP @@ -110,25 +129,41 @@ Do not partition search indices (speeds up import of single country extracts) \fB\-\-no\-updates\fR Do not keep tables that are only needed for updating the database later +.TP +\fB\-\-offline\fR +Do not attempt to load any additional data from the internet + .TP \fB\-\-ignore\-errors\fR Continue import even when errors in SQL are present .TP \fB\-\-index\-noanalyse\fR -Do not perform analyse operations during index +Do not perform analyse operations during index (expert only) + +.TP +\fB\-\-prepare\-database\fR +Create the database but do not import any data .SH OPTIONS 'nominatim freeze' usage: nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM] Make database read\-only. +.br +.br About half of data in the Nominatim database is kept only to be able to +.br keep the data up\-to\-date with new changes made in OpenStreetMap. This +.br command drops all this data and only keeps the part needed for geocoding +.br itself. +.br +.br This command has the same effect as the `\-\-no\-updates` option for imports. +.br @@ -152,11 +187,38 @@ Number of parallel threads to use .SH OPTIONS 'nominatim replication' usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--init] [--no-update-functions] - [--check-for-updates] [--once] [--no-index] - [--osm2pgsql-cache SIZE] + [--check-for-updates] [--once] [--catch-up] + [--no-index] [--osm2pgsql-cache SIZE] [--socket-timeout SOCKET_TIMEOUT] Update the database using an online replication service. +.br + +.br + An OSM replication service is an online service that provides regular +.br + updates (OSM diff files) for the planet or update they provide. The OSMF +.br + provides the primary replication service for the full planet at +.br + https://planet.osm.org/replication/ but there are other providers of +.br + extracts of OSM data who provide such a service as well. +.br + +.br + This sub\-command allows to set up such a replication service and download +.br + and import updates at regular intervals. You need to call '\-\-init' once to +.br + set up the process or whenever you change the replication configuration +.br + parameters. Without any arguments, the sub\-command will go into a loop and +.br + continuously apply updates as they become available. Giving `\-\-once` just +.br + downloads and imports the next batch of updates. +.br @@ -183,7 +245,7 @@ Initialise the update process .TP \fB\-\-no\-update\-functions\fR -Do not update the trigger function to support differential updates. +Do not update the trigger function to support differential updates (EXPERT) .TP \fB\-\-check\-for\-updates\fR @@ -193,9 +255,13 @@ Check if new updates are available and exit \fB\-\-once\fR Download and apply updates only once. When not set, updates are continuously applied +.TP +\fB\-\-catch\-up\fR +Download and apply updates until no new data is available on the server + .TP \fB\-\-no\-index\fR -Do not index the new data. Only applicable together with \-\-once +Do not index the new data. Only usable together with \-\-once .TP \fB\-\-osm2pgsql\-cache\fR SIZE @@ -203,13 +269,61 @@ Size of cache to be used by osm2pgsql (in MB) .TP \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR -Set timeout for file downloads. +Set timeout for file downloads .SH OPTIONS 'nominatim special-phrases' usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--import-from-wiki] + [--import-from-wiki] [--import-from-csv FILE] + [--no-replace] Import special phrases. +.br + +.br + Special phrases are search terms that narrow down the type of object +.br + that should be searched. For example, you might want to search for +.br + 'Hotels in Barcelona'. The OSM wiki has a selection of special phrases +.br + in many languages, which can be imported with this command. +.br + +.br + You can also provide your own phrases in a CSV file. The file needs to have +.br + the following five columns: +.br + * phrase \- the term expected for searching +.br + * class \- the OSM tag key of the object type +.br + * type \- the OSM tag value of the object type +.br + * operator \- the kind of search to be done (one of: in, near, name, \-) +.br + * plural \- whether the term is a plural or not (Y/N) +.br + +.br + An example file can be found in the Nominatim sources at +.br + 'test/testdb/full_en_phrases_test.csv'. +.br + +.br + The import can be further configured to ignore specific key/value pairs. +.br + This is particularly useful when importing phrases from the wiki. The +.br + default configuration excludes some very common tags like building=yes. +.br + The configuration can be customized by putting a file `phrase\-settings.json` +.br + with custom rules into the project directory or by using the `\-\-config` +.br + option to point to another configuration file. +.br @@ -232,17 +346,48 @@ Number of parallel threads to use .TP \fB\-\-import\-from\-wiki\fR -Import special phrases from the OSM wiki to the database. +Import special phrases from the OSM wiki to the database + +.TP +\fB\-\-import\-from\-csv\fR FILE +Import special phrases from a CSV file + +.TP +\fB\-\-no\-replace\fR +Keep the old phrases and only add the new ones .SH OPTIONS 'nominatim add-data' usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM] (--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR) - [--use-main-api] + [--use-main-api] [--osm2pgsql-cache SIZE] + [--socket-timeout SOCKET_TIMEOUT] Add additional data from a file or an online source. - - Data is only imported, not indexed. You need to call `nominatim index` - to complete the process. +.br + +.br + This command allows to add or update the search data in the database. +.br + The data can come either from an OSM file or single OSM objects can +.br + directly be downloaded from the OSM API. This function only loads the +.br + data into the database. Afterwards it still needs to be integrated +.br + in the search index. Use the `nominatim index` command for that. +.br + +.br + The command can also be used to add external non\-OSM data to the +.br + database. At the moment the only supported format is TIGER housenumber +.br + data. See the online documentation at +.br + https://nominatim.org/release\-docs/latest/customize/Tiger/ +.br + for more information. +.br @@ -265,11 +410,11 @@ Number of parallel threads to use .TP \fB\-\-file\fR FILE -Import data from an OSM file +Import data from an OSM file or diff file .TP \fB\-\-diff\fR FILE -Import data from an OSM diff file +Import data from an OSM diff file (deprecated: use \-\-file) .TP \fB\-\-node\fR ID @@ -285,18 +430,37 @@ Import a single relation from the API .TP \fB\-\-tiger\-data\fR DIR -Add housenumbers from the US TIGER census database. +Add housenumbers from the US TIGER census database .TP \fB\-\-use\-main\-api\fR Use OSM API instead of Overpass to download objects +.TP +\fB\-\-osm2pgsql\-cache\fR SIZE +Size of cache to be used by osm2pgsql (in MB) + +.TP +\fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR +Set timeout for file downloads + .SH OPTIONS 'nominatim index' usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--boundaries-only] [--no-boundaries] [--minrank RANK] [--maxrank RANK] Reindex all new and modified data. +.br + +.br + Indexing is the process of computing the address and search terms for +.br + the places in the database. Every time data is added or changed, indexing +.br + needs to be run. Imports and replication updates automatically take care +.br + of indexing. For other cases, this function allows to run indexing manually. +.br @@ -335,14 +499,30 @@ Maximum/finishing rank .SH OPTIONS 'nominatim refresh' usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--postcodes] [--word-counts] [--address-levels] - [--functions] [--wiki-data] [--importance] - [--website] [--no-diff-updates] - [--enable-debug-statements] + [--postcodes] [--word-tokens] [--word-counts] + [--address-levels] [--functions] [--wiki-data] + [--secondary-importance] [--importance] [--website] + [--data-object OBJECT] [--data-area OBJECT] + [--no-diff-updates] [--enable-debug-statements] Recompute auxiliary data used by the indexing process. - - These functions must not be run in parallel with other update commands. +.br + +.br + This sub\-commands updates various static data and functions in the database. +.br + It usually needs to be run after changing various aspects of the +.br + configuration. The configuration documentation will mention the exact +.br + command to use in such case. +.br + +.br + Warning: the 'update' command must not be run in parallel with other update +.br + commands like 'replication' or 'add\-data'. +.br @@ -367,6 +547,10 @@ Number of parallel threads to use \fB\-\-postcodes\fR Update postcode centroid table +.TP +\fB\-\-word\-tokens\fR +Clean up search terms + .TP \fB\-\-word\-counts\fR Compute frequency of full\-word search terms @@ -381,7 +565,11 @@ Update the PL/pgSQL functions in the database .TP \fB\-\-wiki\-data\fR -Update Wikipedia/data importance numbers. +Update Wikipedia/data importance numbers + +.TP +\fB\-\-secondary\-importance\fR +Update secondary importance raster data .TP \fB\-\-importance\fR @@ -391,6 +579,14 @@ Recompute place importances (expensive!) \fB\-\-website\fR Refresh the directory that serves the scripts for the web API +.TP +\fB\-\-data\-object\fR OBJECT +Mark the given OSM object as requiring an update (format: [NWR]) + +.TP +\fB\-\-data\-area\fR OBJECT +Mark the area around the given OSM object as requiring an update (format: [NWR]) + .TP \fB\-\-no\-diff\-updates\fR Do not enable code for propagating updates @@ -401,11 +597,12 @@ Enable debug warning statements in functions .SH OPTIONS 'nominatim admin' usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - (--warm | --check-database | --migrate | --analyse-indexing) + (--warm | --check-database | --migrate | --analyse-indexing | --collect-os-info | --clean-deleted AGE) [--search-only] [--reverse-only] [--osm-id OSM_ID | --place-id PLACE_ID] Analyse and maintain the database. +.br @@ -428,19 +625,27 @@ Number of parallel threads to use .TP \fB\-\-warm\fR -Warm database caches for search and reverse queries. +Warm database caches for search and reverse queries .TP \fB\-\-check\-database\fR -Check that the database is complete and operational. +Check that the database is complete and operational .TP \fB\-\-migrate\fR -Migrate the database to a new software version. +Migrate the database to a new software version .TP \fB\-\-analyse\-indexing\fR -Print performance analysis of the indexing process. +Print performance analysis of the indexing process + +.TP +\fB\-\-collect\-os\-info\fR +Generate a report about the host system information + +.TP +\fB\-\-clean\-deleted\fR AGE +Clean up deleted relations .TP \fB\-\-search\-only\fR @@ -460,14 +665,18 @@ Analyse indexing of the given Nominatim object .SH OPTIONS 'nominatim export' usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--output-type {continent,country,state,county,city,suburb,street,path}] - [--output-format OUTPUT_FORMAT] - [--output-all-postcodes] [--language LANGUAGE] + [--output-type {country,state,county,city,suburb,street,path}] + [--output-format OUTPUT_FORMAT] [--language LANGUAGE] [--restrict-to-country COUNTRY_CODE] [--restrict-to-osm-node ID] [--restrict-to-osm-way ID] [--restrict-to-osm-relation ID] - Export addresses as CSV file from the database. + Export places as CSV file from the database. +.br + +.br + +.br @@ -489,16 +698,12 @@ Base directory of the Nominatim installation (default:.) Number of parallel threads to use .TP -\fB\-\-output\-type\fR {continent,country,state,county,city,suburb,street,path} +\fB\-\-output\-type\fR {country,state,county,city,suburb,street,path} Type of places to output (default: street) .TP \fB\-\-output\-format\fR \fI\,OUTPUT_FORMAT\/\fR -Semicolon\-separated list of address types (see \-\-output\-type). Multiple ranks can be merged into one column by simply using a comma\-separated list. - -.TP -\fB\-\-output\-all\-postcodes\fR -List all postcodes for address instead of just the most likely one +Semicolon\-separated list of address types (see \-\-output\-type). Additionally accepts:placeid,postcode .TP \fB\-\-language\fR \fI\,LANGUAGE\/\fR @@ -520,17 +725,88 @@ Export only children of this OSM way \fB\-\-restrict\-to\-osm\-relation\fR ID Export only children of this OSM relation +.SH OPTIONS 'nominatim convert' +usage: nominatim convert [-h] [-q] [-v] [--project-dir DIR] [-j NUM] + [--format {sqlite}] --output OUTPUT [--with-reverse] + [--with-search] [--with-details] + + Convert an existing database into a different format. (EXPERIMENTAL) +.br + +.br + Dump a read\-only version of the database in a different format. +.br + At the moment only a SQLite database suitable for reverse lookup +.br + can be created. +.br + + + +.TP +\fB\-\-format\fR {sqlite} +Format of the output database (must be sqlite currently) + +.TP +\fB\-\-output\fR \fI\,OUTPUT\/\fR, \fB\-o\fR \fI\,OUTPUT\/\fR +File to write the database to. + +.TP +\fB\-q\fR, \fB\-\-quiet\fR +Print only error messages + +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Increase verboseness of output + +.TP +\fB\-\-project\-dir\fR DIR +Base directory of the Nominatim installation (default:.) + +.TP +\fB\-j\fR NUM, \fB\-\-threads\fR NUM +Number of parallel threads to use + +.TP +\fB\-\-with\-reverse\fR, \fB\-\-without\-reverse\fR +Enable/disable support for reverse and lookup API (default: enabled) + +.TP +\fB\-\-with\-search\fR, \fB\-\-without\-search\fR +Enable/disable support for search API (default: disabled) + +.TP +\fB\-\-with\-details\fR, \fB\-\-without\-details\fR +Enable/disable support for details API (default: enabled) + .SH OPTIONS 'nominatim serve' usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--server SERVER] + [--server SERVER] [--engine {php,falcon,starlette}] Start a simple web server for serving the API. +.br - This command starts the built\-in PHP webserver to serve the website +.br + This command starts a built\-in webserver to serve the website +.br from the current project directory. This webserver is only suitable - for testing and develop. Do not use it in production setups! - +.br + for testing and development. Do not use it in production setups! +.br + +.br + There are different webservers available. The default 'php' engine +.br + runs the classic PHP frontend. The other engines are Python servers +.br + which run the new Python frontend code. This is highly experimental +.br + at the moment and may not include the full API. +.br + +.br By the default, the webserver can be accessed at: http://127.0.0.1:8088 +.br @@ -555,12 +831,16 @@ Number of parallel threads to use \fB\-\-server\fR \fI\,SERVER\/\fR The address the server will listen to. +.TP +\fB\-\-engine\fR {php,falcon,starlette} +Webserver framework to run. (default: falcon) + .SH OPTIONS 'nominatim search' usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--query QUERY] [--street STREET] [--city CITY] - [--county COUNTY] [--state STATE] [--country COUNTRY] - [--postalcode POSTALCODE] - [--format {xml,json,jsonv2,geojson,geocodejson}] + [--query QUERY] [--amenity AMENITY] [--street STREET] + [--city CITY] [--county COUNTY] [--state STATE] + [--country COUNTRY] [--postalcode POSTALCODE] + [--format {xml,geojson,geocodejson,json,jsonv2,debug}] [--addressdetails] [--extratags] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] @@ -568,7 +848,18 @@ usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--exclude_place_ids ID,..] [--limit LIMIT] [--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe] - Execute API search query. + Execute a search query. +.br + +.br + This command works exactly the same as if calling the /search endpoint on +.br + the web API. See the online documentation for more details on the +.br + various parameters: +.br + https://nominatim.org/release\-docs/latest/api/Search/ +.br @@ -593,6 +884,10 @@ Number of parallel threads to use \fB\-\-query\fR \fI\,QUERY\/\fR Free\-form query string +.TP +\fB\-\-amenity\fR \fI\,AMENITY\/\fR +Structured query: name and/or type of POI + .TP \fB\-\-street\fR \fI\,STREET\/\fR Structured query: housenumber and street @@ -618,20 +913,20 @@ Structured query: country Structured query: postcode .TP -\fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson} +\fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug} Format of result .TP \fB\-\-addressdetails\fR -Include a breakdown of the address into elements. +Include a breakdown of the address into elements .TP \fB\-\-extratags\fR -Include additional information if available (e.g. wikipedia link, opening hours). +Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-namedetails\fR -Include a list of alternative names. +Include a list of alternative names .TP \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS @@ -639,7 +934,7 @@ Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR {geojson,kml,svg,text} -Output geometry of results as a GeoJSON, KML, SVG or WKT. +Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR TOLERANCE @@ -647,7 +942,7 @@ Simplify output geometry.Parameter is difference tolerance in degrees. .TP \fB\-\-countrycodes\fR CC,.. -Limit search results to one or more countries. +Limit search results to one or more countries .TP \fB\-\-exclude_place_ids\fR ID,.. @@ -671,14 +966,25 @@ Do not remove duplicates from the result list .SH OPTIONS 'nominatim reverse' usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT - --lon LON [--zoom ZOOM] - [--format {xml,json,jsonv2,geojson,geocodejson}] + --lon LON [--zoom ZOOM] [--layer LAYER] + [--format {xml,geojson,geocodejson,json,jsonv2,debug}] [--addressdetails] [--extratags] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] [--polygon-threshold TOLERANCE] Execute API reverse query. +.br + +.br + This command works exactly the same as if calling the /reverse endpoint on +.br + the web API. See the online documentation for more details on the +.br + various parameters: +.br + https://nominatim.org/release\-docs/latest/api/Reverse/ +.br @@ -712,20 +1018,24 @@ Longitude of coordinate to look up (in WGS84) Level of detail required for the address .TP -\fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson} +\fB\-\-layer\fR LAYER +OSM id to lookup in format (may be repeated) + +.TP +\fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug} Format of result .TP \fB\-\-addressdetails\fR -Include a breakdown of the address into elements. +Include a breakdown of the address into elements .TP \fB\-\-extratags\fR -Include additional information if available (e.g. wikipedia link, opening hours). +Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-namedetails\fR -Include a list of alternative names. +Include a list of alternative names .TP \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS @@ -733,7 +1043,7 @@ Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR {geojson,kml,svg,text} -Output geometry of results as a GeoJSON, KML, SVG or WKT. +Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR TOLERANCE @@ -741,13 +1051,24 @@ Simplify output geometry.Parameter is difference tolerance in degrees. .SH OPTIONS 'nominatim lookup' usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID - [--format {xml,json,jsonv2,geojson,geocodejson}] + [--format {xml,geojson,geocodejson,json,jsonv2,debug}] [--addressdetails] [--extratags] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] [--polygon-threshold TOLERANCE] Execute API lookup query. +.br + +.br + This command works exactly the same as if calling the /lookup endpoint on +.br + the web API. See the online documentation for more details on the +.br + various parameters: +.br + https://nominatim.org/release\-docs/latest/api/Lookup/ +.br @@ -773,20 +1094,20 @@ Number of parallel threads to use OSM id to lookup in format (may be repeated) .TP -\fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson} +\fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug} Format of result .TP \fB\-\-addressdetails\fR -Include a breakdown of the address into elements. +Include a breakdown of the address into elements .TP \fB\-\-extratags\fR -Include additional information if available (e.g. wikipedia link, opening hours). +Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-namedetails\fR -Include a list of alternative names. +Include a list of alternative names .TP \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS @@ -794,7 +1115,7 @@ Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR {geojson,kml,svg,text} -Output geometry of results as a GeoJSON, KML, SVG or WKT. +Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR TOLERANCE @@ -809,6 +1130,17 @@ usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--lang LANGS] Execute API details query. +.br + +.br + This command works exactly the same as if calling the /details endpoint on +.br + the web API. See the online documentation for more details on the +.br + various parameters: +.br + https://nominatim.org/release\-docs/latest/api/Details/ +.br @@ -843,7 +1175,7 @@ Look up the OSM relation with the given ID. .TP \fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR -Database internal identifier of the OSM object to look up. +Database internal identifier of the OSM object to look up .TP \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR @@ -851,27 +1183,27 @@ Class type to disambiguated multiple entries of the same object. .TP \fB\-\-addressdetails\fR -Include a breakdown of the address into elements. +Include a breakdown of the address into elements .TP \fB\-\-keywords\fR -Include a list of name keywords and address keywords. +Include a list of name keywords and address keywords .TP \fB\-\-linkedplaces\fR -Include a details of places that are linked with this one. +Include a details of places that are linked with this one .TP \fB\-\-hierarchy\fR -Include details of places lower in the address hierarchy. +Include details of places lower in the address hierarchy .TP \fB\-\-group_hierarchy\fR -Group the places by type. +Group the places by type .TP \fB\-\-polygon_geojson\fR -Include geometry of result. +Include geometry of result .TP \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS @@ -882,6 +1214,17 @@ usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--format {text,json}] Execute API status query. +.br + +.br + This command works exactly the same as if calling the /status endpoint on +.br + the web API. See the online documentation for more details on the +.br + various parameters: +.br + https://nominatim.org/release\-docs/latest/api/Status/ +.br @@ -906,6 +1249,9 @@ Number of parallel threads to use \fB\-\-format\fR {text,json} Format of result +.SH AUTHORS +.B Nominatim +was written by the Nominatim developer community . .SH DISTRIBUTION The latest version of Nominatim may be downloaded from .UR https://nominatim.org