]> git.openstreetmap.org Git - nominatim.git/blob - man/nominatim.1
remove cmake and related installation instructions
[nominatim.git] / man / nominatim.1
1 .TH nominatim "1" Manual
2 .SH NAME
3 nominatim
4 .SH SYNOPSIS
5 .B nominatim
6 [-h] [--version] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,convert,serve,search,reverse,lookup,details,status} ...
7 .SH DESCRIPTION
8     Command\-line tools for importing, updating, administrating and
9 .br
10     querying the Nominatim database.
11 .br
12     
13 .SH OPTIONS
14
15 .TP
16 \fB\-\-version\fR
17 Print Nominatim version and exit
18
19 .SS
20 \fBSub-commands\fR
21 .TP
22 \fBnominatim\fR \fI\,import\/\fR
23     Create a new Nominatim database from an OSM file.
24 .TP
25 \fBnominatim\fR \fI\,freeze\/\fR
26     Make database read-only.
27 .TP
28 \fBnominatim\fR \fI\,replication\/\fR
29     Update the database using an online replication service.
30 .TP
31 \fBnominatim\fR \fI\,special-phrases\/\fR
32     Import special phrases.
33 .TP
34 \fBnominatim\fR \fI\,add-data\/\fR
35     Add additional data from a file or an online source.
36 .TP
37 \fBnominatim\fR \fI\,index\/\fR
38     Reindex all new and modified data.
39 .TP
40 \fBnominatim\fR \fI\,refresh\/\fR
41     Recompute auxiliary data used by the indexing process.
42 .TP
43 \fBnominatim\fR \fI\,admin\/\fR
44     Analyse and maintain the database.
45 .TP
46 \fBnominatim\fR \fI\,export\/\fR
47     Export places as CSV file from the database.
48 .TP
49 \fBnominatim\fR \fI\,convert\/\fR
50  Convert an existing database into a different format. (EXPERIMENTAL)
51 .TP
52 \fBnominatim\fR \fI\,serve\/\fR
53     Start a simple web server for serving the API.
54 .TP
55 \fBnominatim\fR \fI\,search\/\fR
56     Execute a search query.
57 .TP
58 \fBnominatim\fR \fI\,reverse\/\fR
59     Execute API reverse query.
60 .TP
61 \fBnominatim\fR \fI\,lookup\/\fR
62     Execute API lookup query.
63 .TP
64 \fBnominatim\fR \fI\,details\/\fR
65     Execute API details query.
66 .TP
67 \fBnominatim\fR \fI\,status\/\fR
68
69 .SH OPTIONS 'nominatim import'
70 usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
71                         [--osm-file FILE]
72                         [--continue {import-from-file,load-data,indexing,db-postprocess}]
73                         [--osm2pgsql-cache SIZE] [--reverse-only]
74                         [--no-partitions] [--no-updates] [--offline]
75                         [--ignore-errors] [--index-noanalyse]
76                         [--prepare-database]
77
78     Create a new Nominatim database from an OSM file.
79 .br
80
81 .br
82     This sub\-command sets up a new Nominatim database from scratch starting
83 .br
84     with creating a new database in Postgresql. The user running this command
85 .br
86     needs superuser rights on the database.
87 .br
88     
89
90
91
92 .TP
93 \fB\-q\fR, \fB\-\-quiet\fR
94 Print only error messages
95
96 .TP
97 \fB\-v\fR, \fB\-\-verbose\fR
98 Increase verboseness of output
99
100 .TP
101 \fB\-\-project\-dir\fR DIR
102 Base directory of the Nominatim installation (default:.)
103
104 .TP
105 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
106 Number of parallel threads to use
107
108 .TP
109 \fB\-\-osm\-file\fR FILE
110 OSM file to be imported (repeat for importing multiple files)
111
112 .TP
113 \fB\-\-continue\fR {import\-from\-file,load\-data,indexing,db\-postprocess}
114 Continue an import that was interrupted
115
116 .TP
117 \fB\-\-osm2pgsql\-cache\fR SIZE
118 Size of cache to be used by osm2pgsql (in MB)
119
120 .TP
121 \fB\-\-reverse\-only\fR
122 Do not create tables and indexes for searching
123
124 .TP
125 \fB\-\-no\-partitions\fR
126 Do not partition search indices (speeds up import of single country extracts)
127
128 .TP
129 \fB\-\-no\-updates\fR
130 Do not keep tables that are only needed for updating the database later
131
132 .TP
133 \fB\-\-offline\fR
134 Do not attempt to load any additional data from the internet
135
136 .TP
137 \fB\-\-ignore\-errors\fR
138 Continue import even when errors in SQL are present
139
140 .TP
141 \fB\-\-index\-noanalyse\fR
142 Do not perform analyse operations during index (expert only)
143
144 .TP
145 \fB\-\-prepare\-database\fR
146 Create the database but do not import any data
147
148 .SH OPTIONS 'nominatim freeze'
149 usage: nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
150
151     Make database read\-only.
152 .br
153
154 .br
155     About half of data in the Nominatim database is kept only to be able to
156 .br
157     keep the data up\-to\-date with new changes made in OpenStreetMap. This
158 .br
159     command drops all this data and only keeps the part needed for geocoding
160 .br
161     itself.
162 .br
163
164 .br
165     This command has the same effect as the `\-\-no\-updates` option for imports.
166 .br
167     
168
169
170
171 .TP
172 \fB\-q\fR, \fB\-\-quiet\fR
173 Print only error messages
174
175 .TP
176 \fB\-v\fR, \fB\-\-verbose\fR
177 Increase verboseness of output
178
179 .TP
180 \fB\-\-project\-dir\fR DIR
181 Base directory of the Nominatim installation (default:.)
182
183 .TP
184 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
185 Number of parallel threads to use
186
187 .SH OPTIONS 'nominatim replication'
188 usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
189                              [--init] [--no-update-functions]
190                              [--check-for-updates] [--once] [--catch-up]
191                              [--no-index] [--osm2pgsql-cache SIZE]
192                              [--socket-timeout SOCKET_TIMEOUT]
193
194     Update the database using an online replication service.
195 .br
196
197 .br
198     An OSM replication service is an online service that provides regular
199 .br
200     updates (OSM diff files) for the planet or update they provide. The OSMF
201 .br
202     provides the primary replication service for the full planet at
203 .br
204     https://planet.osm.org/replication/ but there are other providers of
205 .br
206     extracts of OSM data who provide such a service as well.
207 .br
208
209 .br
210     This sub\-command allows to set up such a replication service and download
211 .br
212     and import updates at regular intervals. You need to call '\-\-init' once to
213 .br
214     set up the process or whenever you change the replication configuration
215 .br
216     parameters. Without any arguments, the sub\-command will go into a loop and
217 .br
218     continuously apply updates as they become available. Giving `\-\-once` just
219 .br
220     downloads and imports the next batch of updates.
221 .br
222     
223
224
225
226 .TP
227 \fB\-q\fR, \fB\-\-quiet\fR
228 Print only error messages
229
230 .TP
231 \fB\-v\fR, \fB\-\-verbose\fR
232 Increase verboseness of output
233
234 .TP
235 \fB\-\-project\-dir\fR DIR
236 Base directory of the Nominatim installation (default:.)
237
238 .TP
239 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
240 Number of parallel threads to use
241
242 .TP
243 \fB\-\-init\fR
244 Initialise the update process
245
246 .TP
247 \fB\-\-no\-update\-functions\fR
248 Do not update the trigger function to support differential updates (EXPERT)
249
250 .TP
251 \fB\-\-check\-for\-updates\fR
252 Check if new updates are available and exit
253
254 .TP
255 \fB\-\-once\fR
256 Download and apply updates only once. When not set, updates are continuously applied
257
258 .TP
259 \fB\-\-catch\-up\fR
260 Download and apply updates until no new data is available on the server
261
262 .TP
263 \fB\-\-no\-index\fR
264 Do not index the new data. Only usable together with \-\-once
265
266 .TP
267 \fB\-\-osm2pgsql\-cache\fR SIZE
268 Size of cache to be used by osm2pgsql (in MB)
269
270 .TP
271 \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
272 Set timeout for file downloads
273
274 .SH OPTIONS 'nominatim special-phrases'
275 usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
276                                  [--import-from-wiki] [--import-from-csv FILE]
277                                  [--no-replace]
278
279     Import special phrases.
280 .br
281
282 .br
283     Special phrases are search terms that narrow down the type of object
284 .br
285     that should be searched. For example, you might want to search for
286 .br
287     'Hotels in Barcelona'. The OSM wiki has a selection of special phrases
288 .br
289     in many languages, which can be imported with this command.
290 .br
291
292 .br
293     You can also provide your own phrases in a CSV file. The file needs to have
294 .br
295     the following five columns:
296 .br
297      * phrase \- the term expected for searching
298 .br
299      * class \- the OSM tag key of the object type
300 .br
301      * type \- the OSM tag value of the object type
302 .br
303      * operator \- the kind of search to be done (one of: in, near, name, \-)
304 .br
305      * plural \- whether the term is a plural or not (Y/N)
306 .br
307
308 .br
309     An example file can be found in the Nominatim sources at
310 .br
311     'test/testdb/full_en_phrases_test.csv'.
312 .br
313
314 .br
315     The import can be further configured to ignore specific key/value pairs.
316 .br
317     This is particularly useful when importing phrases from the wiki. The
318 .br
319     default configuration excludes some very common tags like building=yes.
320 .br
321     The configuration can be customized by putting a file `phrase\-settings.json`
322 .br
323     with custom rules into the project directory or by using the `\-\-config`
324 .br
325     option to point to another configuration file.
326 .br
327     
328
329
330
331 .TP
332 \fB\-q\fR, \fB\-\-quiet\fR
333 Print only error messages
334
335 .TP
336 \fB\-v\fR, \fB\-\-verbose\fR
337 Increase verboseness of output
338
339 .TP
340 \fB\-\-project\-dir\fR DIR
341 Base directory of the Nominatim installation (default:.)
342
343 .TP
344 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
345 Number of parallel threads to use
346
347 .TP
348 \fB\-\-import\-from\-wiki\fR
349 Import special phrases from the OSM wiki to the database
350
351 .TP
352 \fB\-\-import\-from\-csv\fR FILE
353 Import special phrases from a CSV file
354
355 .TP
356 \fB\-\-no\-replace\fR
357 Keep the old phrases and only add the new ones
358
359 .SH OPTIONS 'nominatim add-data'
360 usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
361                           (--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR)
362                           [--use-main-api] [--osm2pgsql-cache SIZE]
363                           [--socket-timeout SOCKET_TIMEOUT]
364
365     Add additional data from a file or an online source.
366 .br
367
368 .br
369     This command allows to add or update the search data in the database.
370 .br
371     The data can come either from an OSM file or single OSM objects can
372 .br
373     directly be downloaded from the OSM API. This function only loads the
374 .br
375     data into the database. Afterwards it still needs to be integrated
376 .br
377     in the search index. Use the `nominatim index` command for that.
378 .br
379
380 .br
381     The command can also be used to add external non\-OSM data to the
382 .br
383     database. At the moment the only supported format is TIGER housenumber
384 .br
385     data. See the online documentation at
386 .br
387     https://nominatim.org/release\-docs/latest/customize/Tiger/
388 .br
389     for more information.
390 .br
391     
392
393
394
395 .TP
396 \fB\-q\fR, \fB\-\-quiet\fR
397 Print only error messages
398
399 .TP
400 \fB\-v\fR, \fB\-\-verbose\fR
401 Increase verboseness of output
402
403 .TP
404 \fB\-\-project\-dir\fR DIR
405 Base directory of the Nominatim installation (default:.)
406
407 .TP
408 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
409 Number of parallel threads to use
410
411 .TP
412 \fB\-\-file\fR FILE
413 Import data from an OSM file or diff file
414
415 .TP
416 \fB\-\-diff\fR FILE
417 Import data from an OSM diff file (deprecated: use \-\-file)
418
419 .TP
420 \fB\-\-node\fR ID
421 Import a single node from the API
422
423 .TP
424 \fB\-\-way\fR ID
425 Import a single way from the API
426
427 .TP
428 \fB\-\-relation\fR ID
429 Import a single relation from the API
430
431 .TP
432 \fB\-\-tiger\-data\fR DIR
433 Add housenumbers from the US TIGER census database
434
435 .TP
436 \fB\-\-use\-main\-api\fR
437 Use OSM API instead of Overpass to download objects
438
439 .TP
440 \fB\-\-osm2pgsql\-cache\fR SIZE
441 Size of cache to be used by osm2pgsql (in MB)
442
443 .TP
444 \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
445 Set timeout for file downloads
446
447 .SH OPTIONS 'nominatim index'
448 usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
449                        [--boundaries-only] [--no-boundaries] [--minrank RANK]
450                        [--maxrank RANK]
451
452     Reindex all new and modified data.
453 .br
454
455 .br
456     Indexing is the process of computing the address and search terms for
457 .br
458     the places in the database. Every time data is added or changed, indexing
459 .br
460     needs to be run. Imports and replication updates automatically take care
461 .br
462     of indexing. For other cases, this function allows to run indexing manually.
463 .br
464     
465
466
467
468 .TP
469 \fB\-q\fR, \fB\-\-quiet\fR
470 Print only error messages
471
472 .TP
473 \fB\-v\fR, \fB\-\-verbose\fR
474 Increase verboseness of output
475
476 .TP
477 \fB\-\-project\-dir\fR DIR
478 Base directory of the Nominatim installation (default:.)
479
480 .TP
481 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
482 Number of parallel threads to use
483
484 .TP
485 \fB\-\-boundaries\-only\fR
486 Index only administrative boundaries.
487
488 .TP
489 \fB\-\-no\-boundaries\fR
490 Index everything except administrative boundaries.
491
492 .TP
493 \fB\-\-minrank\fR RANK, \fB\-r\fR RANK
494 Minimum/starting rank
495
496 .TP
497 \fB\-\-maxrank\fR RANK, \fB\-R\fR RANK
498 Maximum/finishing rank
499
500 .SH OPTIONS 'nominatim refresh'
501 usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
502                          [--postcodes] [--word-tokens] [--word-counts]
503                          [--address-levels] [--functions] [--wiki-data]
504                          [--secondary-importance] [--importance] [--website]
505                          [--data-object OBJECT] [--data-area OBJECT]
506                          [--no-diff-updates] [--enable-debug-statements]
507
508     Recompute auxiliary data used by the indexing process.
509 .br
510
511 .br
512     This sub\-commands updates various static data and functions in the database.
513 .br
514     It usually needs to be run after changing various aspects of the
515 .br
516     configuration. The configuration documentation will mention the exact
517 .br
518     command to use in such case.
519 .br
520
521 .br
522     Warning: the 'update' command must not be run in parallel with other update
523 .br
524              commands like 'replication' or 'add\-data'.
525 .br
526     
527
528
529
530 .TP
531 \fB\-q\fR, \fB\-\-quiet\fR
532 Print only error messages
533
534 .TP
535 \fB\-v\fR, \fB\-\-verbose\fR
536 Increase verboseness of output
537
538 .TP
539 \fB\-\-project\-dir\fR DIR
540 Base directory of the Nominatim installation (default:.)
541
542 .TP
543 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
544 Number of parallel threads to use
545
546 .TP
547 \fB\-\-postcodes\fR
548 Update postcode centroid table
549
550 .TP
551 \fB\-\-word\-tokens\fR
552 Clean up search terms
553
554 .TP
555 \fB\-\-word\-counts\fR
556 Compute frequency of full\-word search terms
557
558 .TP
559 \fB\-\-address\-levels\fR
560 Reimport address level configuration
561
562 .TP
563 \fB\-\-functions\fR
564 Update the PL/pgSQL functions in the database
565
566 .TP
567 \fB\-\-wiki\-data\fR
568 Update Wikipedia/data importance numbers
569
570 .TP
571 \fB\-\-secondary\-importance\fR
572 Update secondary importance raster data
573
574 .TP
575 \fB\-\-importance\fR
576 Recompute place importances (expensive!)
577
578 .TP
579 \fB\-\-website\fR
580 Refresh the directory that serves the scripts for the web API
581
582 .TP
583 \fB\-\-data\-object\fR OBJECT
584 Mark the given OSM object as requiring an update (format: [NWR]<id>)
585
586 .TP
587 \fB\-\-data\-area\fR OBJECT
588 Mark the area around the given OSM object as requiring an update (format: [NWR]<id>)
589
590 .TP
591 \fB\-\-no\-diff\-updates\fR
592 Do not enable code for propagating updates
593
594 .TP
595 \fB\-\-enable\-debug\-statements\fR
596 Enable debug warning statements in functions
597
598 .SH OPTIONS 'nominatim admin'
599 usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
600                        (--warm | --check-database | --migrate | --analyse-indexing | --collect-os-info | --clean-deleted AGE)
601                        [--search-only] [--reverse-only]
602                        [--osm-id OSM_ID | --place-id PLACE_ID]
603
604     Analyse and maintain the database.
605 .br
606     
607
608
609
610 .TP
611 \fB\-q\fR, \fB\-\-quiet\fR
612 Print only error messages
613
614 .TP
615 \fB\-v\fR, \fB\-\-verbose\fR
616 Increase verboseness of output
617
618 .TP
619 \fB\-\-project\-dir\fR DIR
620 Base directory of the Nominatim installation (default:.)
621
622 .TP
623 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
624 Number of parallel threads to use
625
626 .TP
627 \fB\-\-warm\fR
628 Warm database caches for search and reverse queries
629
630 .TP
631 \fB\-\-check\-database\fR
632 Check that the database is complete and operational
633
634 .TP
635 \fB\-\-migrate\fR
636 Migrate the database to a new software version
637
638 .TP
639 \fB\-\-analyse\-indexing\fR
640 Print performance analysis of the indexing process
641
642 .TP
643 \fB\-\-collect\-os\-info\fR
644 Generate a report about the host system information
645
646 .TP
647 \fB\-\-clean\-deleted\fR AGE
648 Clean up deleted relations
649
650 .TP
651 \fB\-\-search\-only\fR
652 Only pre\-warm tables for search queries
653
654 .TP
655 \fB\-\-reverse\-only\fR
656 Only pre\-warm tables for reverse queries
657
658 .TP
659 \fB\-\-osm\-id\fR \fI\,OSM_ID\/\fR
660 Analyse indexing of the given OSM object
661
662 .TP
663 \fB\-\-place\-id\fR \fI\,PLACE_ID\/\fR
664 Analyse indexing of the given Nominatim object
665
666 .SH OPTIONS 'nominatim export'
667 usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
668                         [--output-type {country,state,county,city,suburb,street,path}]
669                         [--output-format OUTPUT_FORMAT] [--language LANGUAGE]
670                         [--restrict-to-country COUNTRY_CODE]
671                         [--restrict-to-osm-node ID] [--restrict-to-osm-way ID]
672                         [--restrict-to-osm-relation ID]
673
674     Export places as CSV file from the database.
675 .br
676
677 .br
678
679 .br
680     
681
682
683
684 .TP
685 \fB\-q\fR, \fB\-\-quiet\fR
686 Print only error messages
687
688 .TP
689 \fB\-v\fR, \fB\-\-verbose\fR
690 Increase verboseness of output
691
692 .TP
693 \fB\-\-project\-dir\fR DIR
694 Base directory of the Nominatim installation (default:.)
695
696 .TP
697 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
698 Number of parallel threads to use
699
700 .TP
701 \fB\-\-output\-type\fR {country,state,county,city,suburb,street,path}
702 Type of places to output (default: street)
703
704 .TP
705 \fB\-\-output\-format\fR \fI\,OUTPUT_FORMAT\/\fR
706 Semicolon\-separated list of address types (see \-\-output\-type). Additionally accepts:placeid,postcode
707
708 .TP
709 \fB\-\-language\fR \fI\,LANGUAGE\/\fR
710 Preferred language for output (use local name, if omitted)
711
712 .TP
713 \fB\-\-restrict\-to\-country\fR COUNTRY_CODE
714 Export only objects within country
715
716 .TP
717 \fB\-\-restrict\-to\-osm\-node\fR ID
718 Export only children of this OSM node
719
720 .TP
721 \fB\-\-restrict\-to\-osm\-way\fR ID
722 Export only children of this OSM way
723
724 .TP
725 \fB\-\-restrict\-to\-osm\-relation\fR ID
726 Export only children of this OSM relation
727
728 .SH OPTIONS 'nominatim convert'
729 usage: nominatim convert [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
730                          [--format {sqlite}] --output OUTPUT [--with-reverse]
731                          [--with-search] [--with-details]
732
733  Convert an existing database into a different format. (EXPERIMENTAL)
734 .br
735
736 .br
737         Dump a read\-only version of the database in a different format.
738 .br
739         At the moment only a SQLite database suitable for reverse lookup
740 .br
741         can be created.
742 .br
743     
744
745
746 .TP
747 \fB\-\-format\fR {sqlite}
748 Format of the output database (must be sqlite currently)
749
750 .TP
751 \fB\-\-output\fR \fI\,OUTPUT\/\fR, \fB\-o\fR \fI\,OUTPUT\/\fR
752 File to write the database to.
753
754 .TP
755 \fB\-q\fR, \fB\-\-quiet\fR
756 Print only error messages
757
758 .TP
759 \fB\-v\fR, \fB\-\-verbose\fR
760 Increase verboseness of output
761
762 .TP
763 \fB\-\-project\-dir\fR DIR
764 Base directory of the Nominatim installation (default:.)
765
766 .TP
767 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
768 Number of parallel threads to use
769
770 .TP
771 \fB\-\-with\-reverse\fR, \fB\-\-without\-reverse\fR
772 Enable/disable support for reverse and lookup API (default: enabled)
773
774 .TP
775 \fB\-\-with\-search\fR, \fB\-\-without\-search\fR
776 Enable/disable support for search API (default: disabled)
777
778 .TP
779 \fB\-\-with\-details\fR, \fB\-\-without\-details\fR
780 Enable/disable support for details API (default: enabled)
781
782 .SH OPTIONS 'nominatim serve'
783 usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
784                        [--server SERVER] [--engine {php,falcon,starlette}]
785
786     Start a simple web server for serving the API.
787 .br
788
789 .br
790     This command starts a built\-in webserver to serve the website
791 .br
792     from the current project directory. This webserver is only suitable
793 .br
794     for testing and development. Do not use it in production setups!
795 .br
796
797 .br
798     There are different webservers available. The default 'php' engine
799 .br
800     runs the classic PHP frontend. The other engines are Python servers
801 .br
802     which run the new Python frontend code. This is highly experimental
803 .br
804     at the moment and may not include the full API.
805 .br
806
807 .br
808     By the default, the webserver can be accessed at: http://127.0.0.1:8088
809 .br
810     
811
812
813
814 .TP
815 \fB\-q\fR, \fB\-\-quiet\fR
816 Print only error messages
817
818 .TP
819 \fB\-v\fR, \fB\-\-verbose\fR
820 Increase verboseness of output
821
822 .TP
823 \fB\-\-project\-dir\fR DIR
824 Base directory of the Nominatim installation (default:.)
825
826 .TP
827 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
828 Number of parallel threads to use
829
830 .TP
831 \fB\-\-server\fR \fI\,SERVER\/\fR
832 The address the server will listen to.
833
834 .TP
835 \fB\-\-engine\fR {php,falcon,starlette}
836 Webserver framework to run. (default: falcon)
837
838 .SH OPTIONS 'nominatim search'
839 usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
840                         [--query QUERY] [--amenity AMENITY] [--street STREET]
841                         [--city CITY] [--county COUNTY] [--state STATE]
842                         [--country COUNTRY] [--postalcode POSTALCODE]
843                         [--format {xml,geojson,geocodejson,json,jsonv2,debug}]
844                         [--addressdetails] [--extratags] [--namedetails]
845                         [--lang LANGS]
846                         [--polygon-output {geojson,kml,svg,text}]
847                         [--polygon-threshold TOLERANCE] [--countrycodes CC,..]
848                         [--exclude_place_ids ID,..] [--limit LIMIT]
849                         [--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe]
850
851     Execute a search query.
852 .br
853
854 .br
855     This command works exactly the same as if calling the /search endpoint on
856 .br
857     the web API. See the online documentation for more details on the
858 .br
859     various parameters:
860 .br
861     https://nominatim.org/release\-docs/latest/api/Search/
862 .br
863     
864
865
866
867 .TP
868 \fB\-q\fR, \fB\-\-quiet\fR
869 Print only error messages
870
871 .TP
872 \fB\-v\fR, \fB\-\-verbose\fR
873 Increase verboseness of output
874
875 .TP
876 \fB\-\-project\-dir\fR DIR
877 Base directory of the Nominatim installation (default:.)
878
879 .TP
880 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
881 Number of parallel threads to use
882
883 .TP
884 \fB\-\-query\fR \fI\,QUERY\/\fR
885 Free\-form query string
886
887 .TP
888 \fB\-\-amenity\fR \fI\,AMENITY\/\fR
889 Structured query: name and/or type of POI
890
891 .TP
892 \fB\-\-street\fR \fI\,STREET\/\fR
893 Structured query: housenumber and street
894
895 .TP
896 \fB\-\-city\fR \fI\,CITY\/\fR
897 Structured query: city, town or village
898
899 .TP
900 \fB\-\-county\fR \fI\,COUNTY\/\fR
901 Structured query: county
902
903 .TP
904 \fB\-\-state\fR \fI\,STATE\/\fR
905 Structured query: state
906
907 .TP
908 \fB\-\-country\fR \fI\,COUNTRY\/\fR
909 Structured query: country
910
911 .TP
912 \fB\-\-postalcode\fR \fI\,POSTALCODE\/\fR
913 Structured query: postcode
914
915 .TP
916 \fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug}
917 Format of result
918
919 .TP
920 \fB\-\-addressdetails\fR
921 Include a breakdown of the address into elements
922
923 .TP
924 \fB\-\-extratags\fR
925 Include additional information if available (e.g. wikipedia link, opening hours)
926
927 .TP
928 \fB\-\-namedetails\fR
929 Include a list of alternative names
930
931 .TP
932 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
933 Preferred language order for presenting search results
934
935 .TP
936 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
937 Output geometry of results as a GeoJSON, KML, SVG or WKT
938
939 .TP
940 \fB\-\-polygon\-threshold\fR TOLERANCE
941 Simplify output geometry.Parameter is difference tolerance in degrees.
942
943 .TP
944 \fB\-\-countrycodes\fR CC,..
945 Limit search results to one or more countries
946
947 .TP
948 \fB\-\-exclude_place_ids\fR ID,..
949 List of search object to be excluded
950
951 .TP
952 \fB\-\-limit\fR \fI\,LIMIT\/\fR
953 Limit the number of returned results
954
955 .TP
956 \fB\-\-viewbox\fR X1,Y1,X2,Y2
957 Preferred area to find search results
958
959 .TP
960 \fB\-\-bounded\fR
961 Strictly restrict results to viewbox area
962
963 .TP
964 \fB\-\-no\-dedupe\fR
965 Do not remove duplicates from the result list
966
967 .SH OPTIONS 'nominatim reverse'
968 usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT
969                          --lon LON [--zoom ZOOM] [--layer LAYER]
970                          [--format {xml,geojson,geocodejson,json,jsonv2,debug}]
971                          [--addressdetails] [--extratags] [--namedetails]
972                          [--lang LANGS]
973                          [--polygon-output {geojson,kml,svg,text}]
974                          [--polygon-threshold TOLERANCE]
975
976     Execute API reverse query.
977 .br
978
979 .br
980     This command works exactly the same as if calling the /reverse endpoint on
981 .br
982     the web API. See the online documentation for more details on the
983 .br
984     various parameters:
985 .br
986     https://nominatim.org/release\-docs/latest/api/Reverse/
987 .br
988     
989
990
991
992 .TP
993 \fB\-q\fR, \fB\-\-quiet\fR
994 Print only error messages
995
996 .TP
997 \fB\-v\fR, \fB\-\-verbose\fR
998 Increase verboseness of output
999
1000 .TP
1001 \fB\-\-project\-dir\fR DIR
1002 Base directory of the Nominatim installation (default:.)
1003
1004 .TP
1005 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1006 Number of parallel threads to use
1007
1008 .TP
1009 \fB\-\-lat\fR \fI\,LAT\/\fR
1010 Latitude of coordinate to look up (in WGS84)
1011
1012 .TP
1013 \fB\-\-lon\fR \fI\,LON\/\fR
1014 Longitude of coordinate to look up (in WGS84)
1015
1016 .TP
1017 \fB\-\-zoom\fR \fI\,ZOOM\/\fR
1018 Level of detail required for the address
1019
1020 .TP
1021 \fB\-\-layer\fR LAYER
1022 OSM id to lookup in format <NRW><id> (may be repeated)
1023
1024 .TP
1025 \fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug}
1026 Format of result
1027
1028 .TP
1029 \fB\-\-addressdetails\fR
1030 Include a breakdown of the address into elements
1031
1032 .TP
1033 \fB\-\-extratags\fR
1034 Include additional information if available (e.g. wikipedia link, opening hours)
1035
1036 .TP
1037 \fB\-\-namedetails\fR
1038 Include a list of alternative names
1039
1040 .TP
1041 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
1042 Preferred language order for presenting search results
1043
1044 .TP
1045 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
1046 Output geometry of results as a GeoJSON, KML, SVG or WKT
1047
1048 .TP
1049 \fB\-\-polygon\-threshold\fR TOLERANCE
1050 Simplify output geometry.Parameter is difference tolerance in degrees.
1051
1052 .SH OPTIONS 'nominatim lookup'
1053 usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID
1054                         [--format {xml,geojson,geocodejson,json,jsonv2,debug}]
1055                         [--addressdetails] [--extratags] [--namedetails]
1056                         [--lang LANGS]
1057                         [--polygon-output {geojson,kml,svg,text}]
1058                         [--polygon-threshold TOLERANCE]
1059
1060     Execute API lookup query.
1061 .br
1062
1063 .br
1064     This command works exactly the same as if calling the /lookup endpoint on
1065 .br
1066     the web API. See the online documentation for more details on the
1067 .br
1068     various parameters:
1069 .br
1070     https://nominatim.org/release\-docs/latest/api/Lookup/
1071 .br
1072     
1073
1074
1075
1076 .TP
1077 \fB\-q\fR, \fB\-\-quiet\fR
1078 Print only error messages
1079
1080 .TP
1081 \fB\-v\fR, \fB\-\-verbose\fR
1082 Increase verboseness of output
1083
1084 .TP
1085 \fB\-\-project\-dir\fR DIR
1086 Base directory of the Nominatim installation (default:.)
1087
1088 .TP
1089 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1090 Number of parallel threads to use
1091
1092 .TP
1093 \fB\-\-id\fR OSMID
1094 OSM id to lookup in format <NRW><id> (may be repeated)
1095
1096 .TP
1097 \fB\-\-format\fR {xml,geojson,geocodejson,json,jsonv2,debug}
1098 Format of result
1099
1100 .TP
1101 \fB\-\-addressdetails\fR
1102 Include a breakdown of the address into elements
1103
1104 .TP
1105 \fB\-\-extratags\fR
1106 Include additional information if available (e.g. wikipedia link, opening hours)
1107
1108 .TP
1109 \fB\-\-namedetails\fR
1110 Include a list of alternative names
1111
1112 .TP
1113 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
1114 Preferred language order for presenting search results
1115
1116 .TP
1117 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
1118 Output geometry of results as a GeoJSON, KML, SVG or WKT
1119
1120 .TP
1121 \fB\-\-polygon\-threshold\fR TOLERANCE
1122 Simplify output geometry.Parameter is difference tolerance in degrees.
1123
1124 .SH OPTIONS 'nominatim details'
1125 usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
1126                          (--node NODE | --way WAY | --relation RELATION | --place_id PLACE_ID)
1127                          [--class OBJECT_CLASS] [--addressdetails]
1128                          [--keywords] [--linkedplaces] [--hierarchy]
1129                          [--group_hierarchy] [--polygon_geojson]
1130                          [--lang LANGS]
1131
1132     Execute API details query.
1133 .br
1134
1135 .br
1136     This command works exactly the same as if calling the /details endpoint on
1137 .br
1138     the web API. See the online documentation for more details on the
1139 .br
1140     various parameters:
1141 .br
1142     https://nominatim.org/release\-docs/latest/api/Details/
1143 .br
1144     
1145
1146
1147
1148 .TP
1149 \fB\-q\fR, \fB\-\-quiet\fR
1150 Print only error messages
1151
1152 .TP
1153 \fB\-v\fR, \fB\-\-verbose\fR
1154 Increase verboseness of output
1155
1156 .TP
1157 \fB\-\-project\-dir\fR DIR
1158 Base directory of the Nominatim installation (default:.)
1159
1160 .TP
1161 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1162 Number of parallel threads to use
1163
1164 .TP
1165 \fB\-\-node\fR \fI\,NODE\/\fR, \fB\-n\fR \fI\,NODE\/\fR
1166 Look up the OSM node with the given ID.
1167
1168 .TP
1169 \fB\-\-way\fR \fI\,WAY\/\fR, \fB\-w\fR \fI\,WAY\/\fR
1170 Look up the OSM way with the given ID.
1171
1172 .TP
1173 \fB\-\-relation\fR \fI\,RELATION\/\fR, \fB\-r\fR \fI\,RELATION\/\fR
1174 Look up the OSM relation with the given ID.
1175
1176 .TP
1177 \fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR
1178 Database internal identifier of the OSM object to look up
1179
1180 .TP
1181 \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR
1182 Class type to disambiguated multiple entries of the same object.
1183
1184 .TP
1185 \fB\-\-addressdetails\fR
1186 Include a breakdown of the address into elements
1187
1188 .TP
1189 \fB\-\-keywords\fR
1190 Include a list of name keywords and address keywords
1191
1192 .TP
1193 \fB\-\-linkedplaces\fR
1194 Include a details of places that are linked with this one
1195
1196 .TP
1197 \fB\-\-hierarchy\fR
1198 Include details of places lower in the address hierarchy
1199
1200 .TP
1201 \fB\-\-group_hierarchy\fR
1202 Group the places by type
1203
1204 .TP
1205 \fB\-\-polygon_geojson\fR
1206 Include geometry of result
1207
1208 .TP
1209 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
1210 Preferred language order for presenting search results
1211
1212 .SH OPTIONS 'nominatim status'
1213 usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
1214                         [--format {text,json}]
1215
1216     Execute API status query.
1217 .br
1218
1219 .br
1220     This command works exactly the same as if calling the /status endpoint on
1221 .br
1222     the web API. See the online documentation for more details on the
1223 .br
1224     various parameters:
1225 .br
1226     https://nominatim.org/release\-docs/latest/api/Status/
1227 .br
1228     
1229
1230
1231
1232 .TP
1233 \fB\-q\fR, \fB\-\-quiet\fR
1234 Print only error messages
1235
1236 .TP
1237 \fB\-v\fR, \fB\-\-verbose\fR
1238 Increase verboseness of output
1239
1240 .TP
1241 \fB\-\-project\-dir\fR DIR
1242 Base directory of the Nominatim installation (default:.)
1243
1244 .TP
1245 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1246 Number of parallel threads to use
1247
1248 .TP
1249 \fB\-\-format\fR {text,json}
1250 Format of result
1251
1252 .SH AUTHORS
1253 .B Nominatim
1254 was written by the Nominatim developer community <info@nominatim.org>.
1255 .SH DISTRIBUTION
1256 The latest version of Nominatim may be downloaded from
1257 .UR https://nominatim.org
1258 .UE