X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/51e2654cd27b3c2164e986fa7a90b5a20f8390a4..0fabeefc3e65318509a979f327d12e50a67fc802:/manual/nominatim.1 diff --git a/manual/nominatim.1 b/manual/nominatim.1 index 6d20ac52..a26861ff 100644 --- a/manual/nominatim.1 +++ b/manual/nominatim.1 @@ -3,7 +3,7 @@ nominatim .SH SYNOPSIS .B nominatim -[-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status,transition} ... +[-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status} ... .SH DESCRIPTION Command\-line tools for importing, updating, administrating and querying the Nominatim database. @@ -24,7 +24,7 @@ nominatim Update the database using an online replication service. .TP \fBnominatim\fR \fI\,special-phrases\/\fR - Maintain special phrases. + Import special phrases. .TP \fBnominatim\fR \fI\,add-data\/\fR Add additional data from a file or an online source. @@ -58,9 +58,6 @@ nominatim .TP \fBnominatim\fR \fI\,status\/\fR Execute API status query. -.TP -\fBnominatim\fR \fI\,transition\/\fR - Internal functions for code transition. Do not use. .SH OPTIONS 'nominatim import' usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM] (--osm-file FILE | --continue {load-data,indexing,db-postprocess}) @@ -107,13 +104,11 @@ Do not create tables and indexes for searching .TP \fB\-\-no\-partitions\fR -Do not partition search indices - (speeds up import of single country extracts) +Do not partition search indices (speeds up import of single country extracts) .TP \fB\-\-no\-updates\fR -Do not keep tables that are only needed for - updating the database later +Do not keep tables that are only needed for updating the database later .TP \fB\-\-ignore\-errors\fR @@ -188,8 +183,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. .TP \fB\-\-check\-for\-updates\fR @@ -197,13 +191,11 @@ Check if new updates are available and exit .TP \fB\-\-once\fR -Download and apply updates only once. When - not set, updates are continuously applied +Download and apply updates only once. When not set, updates are continuously applied .TP \fB\-\-no\-index\fR -Do not index the new data. Only applicable - together with \-\-once +Do not index the new data. Only applicable together with \-\-once .TP \fB\-\-osm2pgsql\-cache\fR SIZE @@ -215,9 +207,9 @@ Set timeout for file downloads. .SH OPTIONS 'nominatim special-phrases' usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--from-wiki] [-o OUTPUT] + [--import-from-wiki] - Maintain special phrases. + Import special phrases. @@ -239,13 +231,8 @@ Base directory of the Nominatim installation (default:.) Number of parallel threads to use .TP -\fB\-\-from\-wiki\fR -Pull special phrases from the OSM wiki. - -.TP -\fB\-o\fR \fI\,OUTPUT\/\fR, \fB\-\-output\fR \fI\,OUTPUT\/\fR -File to write the preprocessed phrases to. - If omitted, it will be written to stdout. +\fB\-\-import\-from\-wiki\fR +Import special phrases from the OSM wiki to the database. .SH OPTIONS 'nominatim add-data' usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM] @@ -254,7 +241,7 @@ usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM] Add additional data from a file or an online source. - Data is only imported, not indexed. You need to call `nominatim\-update index` + Data is only imported, not indexed. You need to call `nominatim index` to complete the process. @@ -507,20 +494,15 @@ 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. +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 +List all postcodes for address instead of just the most likely one .TP \fB\-\-language\fR \fI\,LANGUAGE\/\fR -Preferred language for output - (use local name, if omitted) +Preferred language for output (use local name, if omitted) .TP \fB\-\-restrict\-to\-country\fR COUNTRY_CODE @@ -645,8 +627,7 @@ 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 @@ -662,8 +643,7 @@ Output geometry of results as a GeoJSON, KML, SVG or WKT. .TP \fB\-\-polygon\-threshold\fR TOLERANCE -Simplify output geometry. - Parameter is difference tolerance in degrees. +Simplify output geometry.Parameter is difference tolerance in degrees. .TP \fB\-\-countrycodes\fR CC,.. @@ -741,8 +721,7 @@ 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 @@ -758,8 +737,7 @@ Output geometry of results as a GeoJSON, KML, SVG or WKT. .TP \fB\-\-polygon\-threshold\fR TOLERANCE -Simplify output geometry. - Parameter is difference tolerance in degrees. +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 @@ -804,8 +782,7 @@ 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 @@ -821,8 +798,7 @@ Output geometry of results as a GeoJSON, KML, SVG or WKT. .TP \fB\-\-polygon\-threshold\fR TOLERANCE -Simplify output geometry. - Parameter is difference tolerance in degrees. +Simplify output geometry.Parameter is difference tolerance in degrees. .SH OPTIONS 'nominatim details' usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM] @@ -871,8 +847,7 @@ Database internal identifier of the OSM object to look up. .TP \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR -Class type to disambiguated multiple entries - of the same object. +Class type to disambiguated multiple entries of the same object. .TP \fB\-\-addressdetails\fR @@ -931,110 +906,7 @@ Number of parallel threads to use \fB\-\-format\fR {text,json} Format of result -.SH OPTIONS 'nominatim transition' -usage: nominatim transition [-h] [-q] [-v] [--project-dir DIR] [-j NUM] - [--create-db] [--setup-db] [--import-data] - [--load-data] [--create-tables] - [--create-partition-tables] [--index] - [--create-search-indices] [--create-country-names] - [--no-partitions] [--osm-file FILE] [--drop] - [--osm2pgsql-cache SIZE] [--no-analyse] - [--ignore-errors] [--reverse-only] - [--tiger-data FILE] - - Internal functions for code transition. Do not use. - - - - -.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\-\-create\-db\fR -Create nominatim db - -.TP -\fB\-\-setup\-db\fR -Build a blank nominatim db - -.TP -\fB\-\-import\-data\fR -Import a osm file - -.TP -\fB\-\-load\-data\fR -Copy data to live tables from import table - -.TP -\fB\-\-create\-tables\fR -Create main tables - -.TP -\fB\-\-create\-partition\-tables\fR -Create required partition tables - -.TP -\fB\-\-index\fR -Index the data - -.TP -\fB\-\-create\-search\-indices\fR -Create additional indices required for search and update - -.TP -\fB\-\-create\-country\-names\fR -Create search index for default country names. - -.TP -\fB\-\-no\-partitions\fR -Do not partition search indices - -.TP -\fB\-\-osm\-file\fR FILE -File to import - -.TP -\fB\-\-drop\fR -Drop tables needed for updates, making the database readonly - -.TP -\fB\-\-osm2pgsql\-cache\fR SIZE -Size of cache to be used by osm2pgsql (in MB) - -.TP -\fB\-\-no\-analyse\fR -Do not perform analyse operations during index - -.TP -\fB\-\-ignore\-errors\fR -Ignore certain erros on import. - -.TP -\fB\-\-reverse\-only\fR -Do not create search tables and indexes - -.TP -\fB\-\-tiger\-data\fR FILE -File to import - -.SH AUTHORS -.B <> -was written by <> <<>>. .SH DISTRIBUTION -The latest version of <> may be downloaded from -.UR <> +The latest version of Nominatim may be downloaded from +.UR https://nominatim.org .UE