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