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