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