rebuild manpage

[nominatim.git] / manual / nominatim.1

diff --git a/manual/nominatim.1 b/manual/nominatim.1
index 34dd0a3ce106b6027f7c569ef2e2f872af02c905..d995f0454d6e5a17b2922a9cb04d909ce6e50827 100644 (file)
--- a/manual/nominatim.1
+++ b/manual/nominatim.1
@@ -6,7 +6,9 @@ nominatim
 [-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status,transition} ...
 .SH DESCRIPTION
     Command\-line tools for importing, updating, administrating and
+.br
     querying the Nominatim database.
+.br
     
 .SH OPTIONS
 
@@ -24,7 +26,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.
@@ -69,6 +71,7 @@ usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                         [--index-noanalyse]
 
     Create a new Nominatim database from an OSM file.
+.br
     
 
 
@@ -125,13 +128,21 @@ Do not perform analyse operations during index
 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
     
 
 
@@ -160,6 +171,7 @@ usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                              [--socket-timeout SOCKET_TIMEOUT]
 
     Update the database using an online replication service.
+.br
     
 
 
@@ -210,9 +222,10 @@ 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.
+.br
     
 
 
@@ -234,12 +247,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]
@@ -247,9 +256,13 @@ usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                           [--use-main-api]
 
     Add additional data from a file or an online source.
+.br
 
-    Data is only imported, not indexed. You need to call `nominatim\-update index`
+.br
+    Data is only imported, not indexed. You need to call `nominatim index`
+.br
     to complete the process.
+.br
     
 
 
@@ -304,6 +317,7 @@ usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                        [--maxrank RANK]
 
     Reindex all new and modified data.
+.br
     
 
 
@@ -348,8 +362,11 @@ usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                          [--enable-debug-statements]
 
     Recompute auxiliary data used by the indexing process.
+.br
 
+.br
     These functions must not be run in parallel with other update commands.
+.br
     
 
 
@@ -413,6 +430,7 @@ usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                        [--osm-id OSM_ID | --place-id PLACE_ID]
 
     Analyse and maintain the database.
+.br
     
 
 
@@ -475,6 +493,7 @@ usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                         [--restrict-to-osm-relation ID]
 
     Export addresses as CSV file from the database.
+.br
     
 
 
@@ -532,12 +551,19 @@ usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                        [--server SERVER]
 
     Start a simple web server for serving the API.
+.br
 
+.br
     This command starts the built\-in PHP webserver to serve the website
+.br
     from the current project directory. This webserver is only suitable
+.br
     for testing and develop. Do not use it in production setups!
+.br
 
+.br
     By the default, the webserver can be accessed at: http://127.0.0.1:8088
+.br
     
 
 
@@ -576,6 +602,7 @@ usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                         [--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe]
 
     Execute API search query.
+.br
     
 
 
@@ -686,6 +713,7 @@ usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT
                          [--polygon-threshold TOLERANCE]
 
     Execute API reverse query.
+.br
     
 
 
@@ -755,6 +783,7 @@ usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID
                         [--polygon-threshold TOLERANCE]
 
     Execute API lookup query.
+.br
     
 
 
@@ -816,6 +845,7 @@ usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                          [--lang LANGS]
 
     Execute API details query.
+.br
     
 
 
@@ -889,6 +919,7 @@ usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                         [--format {text,json}]
 
     Execute API status query.
+.br
     
 
 
@@ -925,6 +956,7 @@ usage: nominatim transition [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
                             [--tiger-data FILE]
 
     Internal functions for code transition. Do not use.
+.br