]> git.openstreetmap.org Git - nominatim.git/blob - manual/nominatim.1
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / manual / nominatim.1
1 .TH nominatim "1" Manual
2 .SH NAME
3 nominatim
4 .SH SYNOPSIS
5 .B nominatim
6 [-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status} ...
7 .SH DESCRIPTION
8     Command\-line tools for importing, updating, administrating and
9     querying the Nominatim database.
10     
11 .SH OPTIONS
12
13
14 .SS
15 \fBSub-commands\fR
16 .TP
17 \fBnominatim\fR \fI\,import\/\fR
18     Create a new Nominatim database from an OSM file.
19 .TP
20 \fBnominatim\fR \fI\,freeze\/\fR
21     Make database read-only.
22 .TP
23 \fBnominatim\fR \fI\,replication\/\fR
24     Update the database using an online replication service.
25 .TP
26 \fBnominatim\fR \fI\,special-phrases\/\fR
27     Import special phrases.
28 .TP
29 \fBnominatim\fR \fI\,add-data\/\fR
30     Add additional data from a file or an online source.
31 .TP
32 \fBnominatim\fR \fI\,index\/\fR
33     Reindex all new and modified data.
34 .TP
35 \fBnominatim\fR \fI\,refresh\/\fR
36     Recompute auxiliary data used by the indexing process.
37 .TP
38 \fBnominatim\fR \fI\,admin\/\fR
39     Analyse and maintain the database.
40 .TP
41 \fBnominatim\fR \fI\,export\/\fR
42     Export addresses as CSV file from the database.
43 .TP
44 \fBnominatim\fR \fI\,serve\/\fR
45     Start a simple web server for serving the API.
46 .TP
47 \fBnominatim\fR \fI\,search\/\fR
48     Execute API search query.
49 .TP
50 \fBnominatim\fR \fI\,reverse\/\fR
51     Execute API reverse query.
52 .TP
53 \fBnominatim\fR \fI\,lookup\/\fR
54     Execute API lookup query.
55 .TP
56 \fBnominatim\fR \fI\,details\/\fR
57     Execute API details query.
58 .TP
59 \fBnominatim\fR \fI\,status\/\fR
60     Execute API status query.
61 .SH OPTIONS 'nominatim import'
62 usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
63                         (--osm-file FILE | --continue {load-data,indexing,db-postprocess})
64                         [--osm2pgsql-cache SIZE] [--reverse-only]
65                         [--no-partitions] [--no-updates] [--ignore-errors]
66                         [--index-noanalyse]
67
68     Create a new Nominatim database from an OSM file.
69     
70
71
72
73 .TP
74 \fB\-q\fR, \fB\-\-quiet\fR
75 Print only error messages
76
77 .TP
78 \fB\-v\fR, \fB\-\-verbose\fR
79 Increase verboseness of output
80
81 .TP
82 \fB\-\-project\-dir\fR DIR
83 Base directory of the Nominatim installation (default:.)
84
85 .TP
86 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
87 Number of parallel threads to use
88
89 .TP
90 \fB\-\-osm\-file\fR FILE
91 OSM file to be imported.
92
93 .TP
94 \fB\-\-continue\fR {load\-data,indexing,db\-postprocess}
95 Continue an import that was interrupted
96
97 .TP
98 \fB\-\-osm2pgsql\-cache\fR SIZE
99 Size of cache to be used by osm2pgsql (in MB)
100
101 .TP
102 \fB\-\-reverse\-only\fR
103 Do not create tables and indexes for searching
104
105 .TP
106 \fB\-\-no\-partitions\fR
107 Do not partition search indices (speeds up import of single country extracts)
108
109 .TP
110 \fB\-\-no\-updates\fR
111 Do not keep tables that are only needed for updating the database later
112
113 .TP
114 \fB\-\-ignore\-errors\fR
115 Continue import even when errors in SQL are present
116
117 .TP
118 \fB\-\-index\-noanalyse\fR
119 Do not perform analyse operations during index
120
121 .SH OPTIONS 'nominatim freeze'
122 usage: nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
123
124     Make database read\-only.
125
126     About half of data in the Nominatim database is kept only to be able to
127     keep the data up\-to\-date with new changes made in OpenStreetMap. This
128     command drops all this data and only keeps the part needed for geocoding
129     itself.
130
131     This command has the same effect as the `\-\-no\-updates` option for imports.
132     
133
134
135
136 .TP
137 \fB\-q\fR, \fB\-\-quiet\fR
138 Print only error messages
139
140 .TP
141 \fB\-v\fR, \fB\-\-verbose\fR
142 Increase verboseness of output
143
144 .TP
145 \fB\-\-project\-dir\fR DIR
146 Base directory of the Nominatim installation (default:.)
147
148 .TP
149 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
150 Number of parallel threads to use
151
152 .SH OPTIONS 'nominatim replication'
153 usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
154                              [--init] [--no-update-functions]
155                              [--check-for-updates] [--once] [--no-index]
156                              [--osm2pgsql-cache SIZE]
157                              [--socket-timeout SOCKET_TIMEOUT]
158
159     Update the database using an online replication service.
160     
161
162
163
164 .TP
165 \fB\-q\fR, \fB\-\-quiet\fR
166 Print only error messages
167
168 .TP
169 \fB\-v\fR, \fB\-\-verbose\fR
170 Increase verboseness of output
171
172 .TP
173 \fB\-\-project\-dir\fR DIR
174 Base directory of the Nominatim installation (default:.)
175
176 .TP
177 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
178 Number of parallel threads to use
179
180 .TP
181 \fB\-\-init\fR
182 Initialise the update process
183
184 .TP
185 \fB\-\-no\-update\-functions\fR
186 Do not update the trigger function to support differential updates.
187
188 .TP
189 \fB\-\-check\-for\-updates\fR
190 Check if new updates are available and exit
191
192 .TP
193 \fB\-\-once\fR
194 Download and apply updates only once. When not set, updates are continuously applied
195
196 .TP
197 \fB\-\-no\-index\fR
198 Do not index the new data. Only applicable together with \-\-once
199
200 .TP
201 \fB\-\-osm2pgsql\-cache\fR SIZE
202 Size of cache to be used by osm2pgsql (in MB)
203
204 .TP
205 \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
206 Set timeout for file downloads.
207
208 .SH OPTIONS 'nominatim special-phrases'
209 usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
210                                  [--import-from-wiki]
211
212     Import special phrases.
213     
214
215
216
217 .TP
218 \fB\-q\fR, \fB\-\-quiet\fR
219 Print only error messages
220
221 .TP
222 \fB\-v\fR, \fB\-\-verbose\fR
223 Increase verboseness of output
224
225 .TP
226 \fB\-\-project\-dir\fR DIR
227 Base directory of the Nominatim installation (default:.)
228
229 .TP
230 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
231 Number of parallel threads to use
232
233 .TP
234 \fB\-\-import\-from\-wiki\fR
235 Import special phrases from the OSM wiki to the database.
236
237 .SH OPTIONS 'nominatim add-data'
238 usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
239                           (--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR)
240                           [--use-main-api]
241
242     Add additional data from a file or an online source.
243
244     Data is only imported, not indexed. You need to call `nominatim index`
245     to complete the process.
246     
247
248
249
250 .TP
251 \fB\-q\fR, \fB\-\-quiet\fR
252 Print only error messages
253
254 .TP
255 \fB\-v\fR, \fB\-\-verbose\fR
256 Increase verboseness of output
257
258 .TP
259 \fB\-\-project\-dir\fR DIR
260 Base directory of the Nominatim installation (default:.)
261
262 .TP
263 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
264 Number of parallel threads to use
265
266 .TP
267 \fB\-\-file\fR FILE
268 Import data from an OSM file
269
270 .TP
271 \fB\-\-diff\fR FILE
272 Import data from an OSM diff file
273
274 .TP
275 \fB\-\-node\fR ID
276 Import a single node from the API
277
278 .TP
279 \fB\-\-way\fR ID
280 Import a single way from the API
281
282 .TP
283 \fB\-\-relation\fR ID
284 Import a single relation from the API
285
286 .TP
287 \fB\-\-tiger\-data\fR DIR
288 Add housenumbers from the US TIGER census database.
289
290 .TP
291 \fB\-\-use\-main\-api\fR
292 Use OSM API instead of Overpass to download objects
293
294 .SH OPTIONS 'nominatim index'
295 usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
296                        [--boundaries-only] [--no-boundaries] [--minrank RANK]
297                        [--maxrank RANK]
298
299     Reindex all new and modified data.
300     
301
302
303
304 .TP
305 \fB\-q\fR, \fB\-\-quiet\fR
306 Print only error messages
307
308 .TP
309 \fB\-v\fR, \fB\-\-verbose\fR
310 Increase verboseness of output
311
312 .TP
313 \fB\-\-project\-dir\fR DIR
314 Base directory of the Nominatim installation (default:.)
315
316 .TP
317 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
318 Number of parallel threads to use
319
320 .TP
321 \fB\-\-boundaries\-only\fR
322 Index only administrative boundaries.
323
324 .TP
325 \fB\-\-no\-boundaries\fR
326 Index everything except administrative boundaries.
327
328 .TP
329 \fB\-\-minrank\fR RANK, \fB\-r\fR RANK
330 Minimum/starting rank
331
332 .TP
333 \fB\-\-maxrank\fR RANK, \fB\-R\fR RANK
334 Maximum/finishing rank
335
336 .SH OPTIONS 'nominatim refresh'
337 usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
338                          [--postcodes] [--word-counts] [--address-levels]
339                          [--functions] [--wiki-data] [--importance]
340                          [--website] [--no-diff-updates]
341                          [--enable-debug-statements]
342
343     Recompute auxiliary data used by the indexing process.
344
345     These functions must not be run in parallel with other update commands.
346     
347
348
349
350 .TP
351 \fB\-q\fR, \fB\-\-quiet\fR
352 Print only error messages
353
354 .TP
355 \fB\-v\fR, \fB\-\-verbose\fR
356 Increase verboseness of output
357
358 .TP
359 \fB\-\-project\-dir\fR DIR
360 Base directory of the Nominatim installation (default:.)
361
362 .TP
363 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
364 Number of parallel threads to use
365
366 .TP
367 \fB\-\-postcodes\fR
368 Update postcode centroid table
369
370 .TP
371 \fB\-\-word\-counts\fR
372 Compute frequency of full\-word search terms
373
374 .TP
375 \fB\-\-address\-levels\fR
376 Reimport address level configuration
377
378 .TP
379 \fB\-\-functions\fR
380 Update the PL/pgSQL functions in the database
381
382 .TP
383 \fB\-\-wiki\-data\fR
384 Update Wikipedia/data importance numbers.
385
386 .TP
387 \fB\-\-importance\fR
388 Recompute place importances (expensive!)
389
390 .TP
391 \fB\-\-website\fR
392 Refresh the directory that serves the scripts for the web API
393
394 .TP
395 \fB\-\-no\-diff\-updates\fR
396 Do not enable code for propagating updates
397
398 .TP
399 \fB\-\-enable\-debug\-statements\fR
400 Enable debug warning statements in functions
401
402 .SH OPTIONS 'nominatim admin'
403 usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
404                        (--warm | --check-database | --migrate | --analyse-indexing)
405                        [--search-only] [--reverse-only]
406                        [--osm-id OSM_ID | --place-id PLACE_ID]
407
408     Analyse and maintain the database.
409     
410
411
412
413 .TP
414 \fB\-q\fR, \fB\-\-quiet\fR
415 Print only error messages
416
417 .TP
418 \fB\-v\fR, \fB\-\-verbose\fR
419 Increase verboseness of output
420
421 .TP
422 \fB\-\-project\-dir\fR DIR
423 Base directory of the Nominatim installation (default:.)
424
425 .TP
426 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
427 Number of parallel threads to use
428
429 .TP
430 \fB\-\-warm\fR
431 Warm database caches for search and reverse queries.
432
433 .TP
434 \fB\-\-check\-database\fR
435 Check that the database is complete and operational.
436
437 .TP
438 \fB\-\-migrate\fR
439 Migrate the database to a new software version.
440
441 .TP
442 \fB\-\-analyse\-indexing\fR
443 Print performance analysis of the indexing process.
444
445 .TP
446 \fB\-\-search\-only\fR
447 Only pre\-warm tables for search queries
448
449 .TP
450 \fB\-\-reverse\-only\fR
451 Only pre\-warm tables for reverse queries
452
453 .TP
454 \fB\-\-osm\-id\fR \fI\,OSM_ID\/\fR
455 Analyse indexing of the given OSM object
456
457 .TP
458 \fB\-\-place\-id\fR \fI\,PLACE_ID\/\fR
459 Analyse indexing of the given Nominatim object
460
461 .SH OPTIONS 'nominatim export'
462 usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
463                         [--output-type {continent,country,state,county,city,suburb,street,path}]
464                         [--output-format OUTPUT_FORMAT]
465                         [--output-all-postcodes] [--language LANGUAGE]
466                         [--restrict-to-country COUNTRY_CODE]
467                         [--restrict-to-osm-node ID] [--restrict-to-osm-way ID]
468                         [--restrict-to-osm-relation ID]
469
470     Export addresses as CSV file from the database.
471     
472
473
474
475 .TP
476 \fB\-q\fR, \fB\-\-quiet\fR
477 Print only error messages
478
479 .TP
480 \fB\-v\fR, \fB\-\-verbose\fR
481 Increase verboseness of output
482
483 .TP
484 \fB\-\-project\-dir\fR DIR
485 Base directory of the Nominatim installation (default:.)
486
487 .TP
488 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
489 Number of parallel threads to use
490
491 .TP
492 \fB\-\-output\-type\fR {continent,country,state,county,city,suburb,street,path}
493 Type of places to output (default: street)
494
495 .TP
496 \fB\-\-output\-format\fR \fI\,OUTPUT_FORMAT\/\fR
497 Semicolon\-separated list of address types (see \-\-output\-type). Multiple ranks can be merged into one column by simply using a comma\-separated list.
498
499 .TP
500 \fB\-\-output\-all\-postcodes\fR
501 List all postcodes for address instead of just the most likely one
502
503 .TP
504 \fB\-\-language\fR \fI\,LANGUAGE\/\fR
505 Preferred language for output (use local name, if omitted)
506
507 .TP
508 \fB\-\-restrict\-to\-country\fR COUNTRY_CODE
509 Export only objects within country
510
511 .TP
512 \fB\-\-restrict\-to\-osm\-node\fR ID
513 Export only children of this OSM node
514
515 .TP
516 \fB\-\-restrict\-to\-osm\-way\fR ID
517 Export only children of this OSM way
518
519 .TP
520 \fB\-\-restrict\-to\-osm\-relation\fR ID
521 Export only children of this OSM relation
522
523 .SH OPTIONS 'nominatim serve'
524 usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
525                        [--server SERVER]
526
527     Start a simple web server for serving the API.
528
529     This command starts the built\-in PHP webserver to serve the website
530     from the current project directory. This webserver is only suitable
531     for testing and develop. Do not use it in production setups!
532
533     By the default, the webserver can be accessed at: http://127.0.0.1:8088
534     
535
536
537
538 .TP
539 \fB\-q\fR, \fB\-\-quiet\fR
540 Print only error messages
541
542 .TP
543 \fB\-v\fR, \fB\-\-verbose\fR
544 Increase verboseness of output
545
546 .TP
547 \fB\-\-project\-dir\fR DIR
548 Base directory of the Nominatim installation (default:.)
549
550 .TP
551 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
552 Number of parallel threads to use
553
554 .TP
555 \fB\-\-server\fR \fI\,SERVER\/\fR
556 The address the server will listen to.
557
558 .SH OPTIONS 'nominatim search'
559 usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
560                         [--query QUERY] [--street STREET] [--city CITY]
561                         [--county COUNTY] [--state STATE] [--country COUNTRY]
562                         [--postalcode POSTALCODE]
563                         [--format {xml,json,jsonv2,geojson,geocodejson}]
564                         [--addressdetails] [--extratags] [--namedetails]
565                         [--lang LANGS]
566                         [--polygon-output {geojson,kml,svg,text}]
567                         [--polygon-threshold TOLERANCE] [--countrycodes CC,..]
568                         [--exclude_place_ids ID,..] [--limit LIMIT]
569                         [--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe]
570
571     Execute API search query.
572     
573
574
575
576 .TP
577 \fB\-q\fR, \fB\-\-quiet\fR
578 Print only error messages
579
580 .TP
581 \fB\-v\fR, \fB\-\-verbose\fR
582 Increase verboseness of output
583
584 .TP
585 \fB\-\-project\-dir\fR DIR
586 Base directory of the Nominatim installation (default:.)
587
588 .TP
589 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
590 Number of parallel threads to use
591
592 .TP
593 \fB\-\-query\fR \fI\,QUERY\/\fR
594 Free\-form query string
595
596 .TP
597 \fB\-\-street\fR \fI\,STREET\/\fR
598 Structured query: housenumber and street
599
600 .TP
601 \fB\-\-city\fR \fI\,CITY\/\fR
602 Structured query: city, town or village
603
604 .TP
605 \fB\-\-county\fR \fI\,COUNTY\/\fR
606 Structured query: county
607
608 .TP
609 \fB\-\-state\fR \fI\,STATE\/\fR
610 Structured query: state
611
612 .TP
613 \fB\-\-country\fR \fI\,COUNTRY\/\fR
614 Structured query: country
615
616 .TP
617 \fB\-\-postalcode\fR \fI\,POSTALCODE\/\fR
618 Structured query: postcode
619
620 .TP
621 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
622 Format of result
623
624 .TP
625 \fB\-\-addressdetails\fR
626 Include a breakdown of the address into elements.
627
628 .TP
629 \fB\-\-extratags\fR
630 Include additional information if available (e.g. wikipedia link, opening hours).
631
632 .TP
633 \fB\-\-namedetails\fR
634 Include a list of alternative names.
635
636 .TP
637 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
638 Preferred language order for presenting search results
639
640 .TP
641 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
642 Output geometry of results as a GeoJSON, KML, SVG or WKT.
643
644 .TP
645 \fB\-\-polygon\-threshold\fR TOLERANCE
646 Simplify output geometry.Parameter is difference tolerance in degrees.
647
648 .TP
649 \fB\-\-countrycodes\fR CC,..
650 Limit search results to one or more countries.
651
652 .TP
653 \fB\-\-exclude_place_ids\fR ID,..
654 List of search object to be excluded
655
656 .TP
657 \fB\-\-limit\fR \fI\,LIMIT\/\fR
658 Limit the number of returned results
659
660 .TP
661 \fB\-\-viewbox\fR X1,Y1,X2,Y2
662 Preferred area to find search results
663
664 .TP
665 \fB\-\-bounded\fR
666 Strictly restrict results to viewbox area
667
668 .TP
669 \fB\-\-no\-dedupe\fR
670 Do not remove duplicates from the result list
671
672 .SH OPTIONS 'nominatim reverse'
673 usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT
674                          --lon LON [--zoom ZOOM]
675                          [--format {xml,json,jsonv2,geojson,geocodejson}]
676                          [--addressdetails] [--extratags] [--namedetails]
677                          [--lang LANGS]
678                          [--polygon-output {geojson,kml,svg,text}]
679                          [--polygon-threshold TOLERANCE]
680
681     Execute API reverse query.
682     
683
684
685
686 .TP
687 \fB\-q\fR, \fB\-\-quiet\fR
688 Print only error messages
689
690 .TP
691 \fB\-v\fR, \fB\-\-verbose\fR
692 Increase verboseness of output
693
694 .TP
695 \fB\-\-project\-dir\fR DIR
696 Base directory of the Nominatim installation (default:.)
697
698 .TP
699 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
700 Number of parallel threads to use
701
702 .TP
703 \fB\-\-lat\fR \fI\,LAT\/\fR
704 Latitude of coordinate to look up (in WGS84)
705
706 .TP
707 \fB\-\-lon\fR \fI\,LON\/\fR
708 Longitude of coordinate to look up (in WGS84)
709
710 .TP
711 \fB\-\-zoom\fR \fI\,ZOOM\/\fR
712 Level of detail required for the address
713
714 .TP
715 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
716 Format of result
717
718 .TP
719 \fB\-\-addressdetails\fR
720 Include a breakdown of the address into elements.
721
722 .TP
723 \fB\-\-extratags\fR
724 Include additional information if available (e.g. wikipedia link, opening hours).
725
726 .TP
727 \fB\-\-namedetails\fR
728 Include a list of alternative names.
729
730 .TP
731 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
732 Preferred language order for presenting search results
733
734 .TP
735 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
736 Output geometry of results as a GeoJSON, KML, SVG or WKT.
737
738 .TP
739 \fB\-\-polygon\-threshold\fR TOLERANCE
740 Simplify output geometry.Parameter is difference tolerance in degrees.
741
742 .SH OPTIONS 'nominatim lookup'
743 usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID
744                         [--format {xml,json,jsonv2,geojson,geocodejson}]
745                         [--addressdetails] [--extratags] [--namedetails]
746                         [--lang LANGS]
747                         [--polygon-output {geojson,kml,svg,text}]
748                         [--polygon-threshold TOLERANCE]
749
750     Execute API lookup query.
751     
752
753
754
755 .TP
756 \fB\-q\fR, \fB\-\-quiet\fR
757 Print only error messages
758
759 .TP
760 \fB\-v\fR, \fB\-\-verbose\fR
761 Increase verboseness of output
762
763 .TP
764 \fB\-\-project\-dir\fR DIR
765 Base directory of the Nominatim installation (default:.)
766
767 .TP
768 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
769 Number of parallel threads to use
770
771 .TP
772 \fB\-\-id\fR OSMID
773 OSM id to lookup in format <NRW><id> (may be repeated)
774
775 .TP
776 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
777 Format of result
778
779 .TP
780 \fB\-\-addressdetails\fR
781 Include a breakdown of the address into elements.
782
783 .TP
784 \fB\-\-extratags\fR
785 Include additional information if available (e.g. wikipedia link, opening hours).
786
787 .TP
788 \fB\-\-namedetails\fR
789 Include a list of alternative names.
790
791 .TP
792 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
793 Preferred language order for presenting search results
794
795 .TP
796 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
797 Output geometry of results as a GeoJSON, KML, SVG or WKT.
798
799 .TP
800 \fB\-\-polygon\-threshold\fR TOLERANCE
801 Simplify output geometry.Parameter is difference tolerance in degrees.
802
803 .SH OPTIONS 'nominatim details'
804 usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
805                          (--node NODE | --way WAY | --relation RELATION | --place_id PLACE_ID)
806                          [--class OBJECT_CLASS] [--addressdetails]
807                          [--keywords] [--linkedplaces] [--hierarchy]
808                          [--group_hierarchy] [--polygon_geojson]
809                          [--lang LANGS]
810
811     Execute API details query.
812     
813
814
815
816 .TP
817 \fB\-q\fR, \fB\-\-quiet\fR
818 Print only error messages
819
820 .TP
821 \fB\-v\fR, \fB\-\-verbose\fR
822 Increase verboseness of output
823
824 .TP
825 \fB\-\-project\-dir\fR DIR
826 Base directory of the Nominatim installation (default:.)
827
828 .TP
829 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
830 Number of parallel threads to use
831
832 .TP
833 \fB\-\-node\fR \fI\,NODE\/\fR, \fB\-n\fR \fI\,NODE\/\fR
834 Look up the OSM node with the given ID.
835
836 .TP
837 \fB\-\-way\fR \fI\,WAY\/\fR, \fB\-w\fR \fI\,WAY\/\fR
838 Look up the OSM way with the given ID.
839
840 .TP
841 \fB\-\-relation\fR \fI\,RELATION\/\fR, \fB\-r\fR \fI\,RELATION\/\fR
842 Look up the OSM relation with the given ID.
843
844 .TP
845 \fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR
846 Database internal identifier of the OSM object to look up.
847
848 .TP
849 \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR
850 Class type to disambiguated multiple entries of the same object.
851
852 .TP
853 \fB\-\-addressdetails\fR
854 Include a breakdown of the address into elements.
855
856 .TP
857 \fB\-\-keywords\fR
858 Include a list of name keywords and address keywords.
859
860 .TP
861 \fB\-\-linkedplaces\fR
862 Include a details of places that are linked with this one.
863
864 .TP
865 \fB\-\-hierarchy\fR
866 Include details of places lower in the address hierarchy.
867
868 .TP
869 \fB\-\-group_hierarchy\fR
870 Group the places by type.
871
872 .TP
873 \fB\-\-polygon_geojson\fR
874 Include geometry of result.
875
876 .TP
877 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
878 Preferred language order for presenting search results
879
880 .SH OPTIONS 'nominatim status'
881 usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
882                         [--format {text,json}]
883
884     Execute API status query.
885     
886
887
888
889 .TP
890 \fB\-q\fR, \fB\-\-quiet\fR
891 Print only error messages
892
893 .TP
894 \fB\-v\fR, \fB\-\-verbose\fR
895 Increase verboseness of output
896
897 .TP
898 \fB\-\-project\-dir\fR DIR
899 Base directory of the Nominatim installation (default:.)
900
901 .TP
902 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
903 Number of parallel threads to use
904
905 .TP
906 \fB\-\-format\fR {text,json}
907 Format of result
908
909 .SH DISTRIBUTION
910 The latest version of Nominatim may be downloaded from
911 .UR https://nominatim.org
912 .UE