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