osmium-create-locations-index(1)

1OSMIUM-CREATE-LOCATIONS-INDEX(1)              OSMIUM-CREATE-LOCATIONS-INDEX(1)
2
3
4

NAME

6       osmium-create-locations-index  -  create or update locations index from
7       OSM file
8

SYNOPSIS

10       osmium create-locations-index -i INDEX-FILE [OPTIONS] OSM-FILE
11

DESCRIPTION

13       Create an index of all node locations from the OSM-FILE in the file IN‐
14       DEX-FILE.
15
16       If the INDEX-FILE exists, it will not be touched unless the --update/-u
17       option is used.
18
19       Regardless of the size of the input file, this index will need about  8
20       *  highest-node-id  bytes  on  disk.  For a current planet file this is
21       more than 50 GBytes.
22
23       The index file format is compatible to the one created by “osmium  add-
24       location-to-ways  -i  dense_file_array,INDEX-FILE”  and to the flatnode
25       store created by osm2pgsql.
26
27       When the input file is a full history file or a change file,  the  last
28       location encountered in the file for any ID ends up in the index.  Usu‐
29       ally this will be the newest location (from the node with  the  highest
30       version).
31
32       This command will not work with negative node IDs.
33
34       This  commands  reads  its input file only once, so it can be streamed,
35       ie.  it can read from STDIN.
36

OPTIONS

38       -i, --index-file=FILENAME
39              The name of the index file.
40
41       -u, --update
42              Allow updating of existing file.
43

COMMON OPTIONS

45       -h, --help
46              Show usage help.
47
48       -v, --verbose
49              Set verbose mode.  The program  will  output  information  about
50              what it is doing to STDERR.
51
52       --progress
53              Show  progress bar.  Usually a progress bar is only displayed if
54              STDOUT and STDERR are detected to be TTY.  With  this  option  a
55              progress  bar  is  always  shown.  Note that a progress bar will
56              never be shown when reading from STDIN or a pipe.
57
58       --no-progress
59              Do not show progress bar.  Usually a progress bar  is  displayed
60              if STDOUT and STDERR are detected to be a TTY.  With this option
61              the progress bar is suppressed.  Note that a progress  bar  will
62              never be shown when reading from STDIN or a pipe.
63

INPUT OPTIONS

65       -F, --input-format=FORMAT
66              The  format  of the input file(s).  Can be used to set the input
67              format if it can’t be autodetected from the file name(s).   This
68              will  set the format for all input files, there is no way to set
69              the format for some  input  files  only.   See  osmium-file-for‐
70              mats(5) or the libosmium manual for details.
71

DIAGNOSTICS

73       osmium create-locations-index exits with exit code
74
75       0      if everything went alright,
76
77       1      if there was an error processing the data, or
78
79       2      if there was a problem with the command line arguments.
80

MEMORY USAGE

82       osmium create-locations-index will not use a lot of memory.
83

EXAMPLES

85       Create node locations index from planet:
86
87              osmium create-locations-index -i locations.idx planet.osm.pbf
88
89       Set a node location in the index using an input file in OPL format:
90
91              echo "n123 x-80.6042 y28.6083" | \
92                  osmium create-locations-index -i locations.idx -F opl --update
93

COPYRIGHT

102       Copyright (C) 2013-2023 Jochen Topf <jochen@topf.org>.
103
104       License  GPLv3+:  GNU  GPL  version  3  or  later  <https://gnu.org/li‐
105       censes/gpl.html>.  This is free software: you are free  to  change  and
106       redistribute it.  There is NO WARRANTY, to the extent permitted by law.
107

CONTACT

109       If  you  have  any  questions  or  want  to  report a bug, please go to
110       https://osmcode.org/contact.html
111

AUTHORS

113       Jochen Topf <jochen@topf.org>.
114
115
116
117                                    1.15.0    OSMIUM-CREATE-LOCATIONS-INDEX(1)