Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OSMIUM-CREATE-LOCATIONS-INDEX(1)		OSMIUM-CREATE-LOCATIONS-INDEX(1)

NAME
     osmium-create-locations-index  -  create or update locations index from OSM
     file

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

DESCRIPTION
     Create an index of all node locations from the OSM-FILE  in  the  file  IN-
     DEX-FILE.

     If the INDEX-FILE exists, it will not be touched unless the --update/-u op-
     tion is used.

     Regardless  of  the  size of the input file, this index will need about 8 *
     highest-node-id bytes on disk.  For a current planet file this is more than
     50 GBytes.

     The index file format is compatible to the one created by "osmium add-loca-
     tion-to-ways -i dense_file_array,INDEX-FILE" and to the flatnode store cre-
     ated by osm2pgsql.

     When the input file is a full history file or a change file, the last loca-
     tion encountered in the file for any ID ends up in the index.  Usually this
     will be the newest location (from the node with the highest version).

     This command will not work with negative node IDs.

     This commands reads its input file only once, so it can  be  streamed,  ie.
     it can read from STDIN.

OPTIONS
     -i, --index-file=FILENAME
	    The name of the index file.

     -u, --update
	    Allow updating of existing file.

COMMON OPTIONS
     -h, --help
	    Show usage help.

     -v, --verbose
	    Set verbose mode.  The program will output information about what it
	    is doing to STDERR.

     --progress
	    Show progress bar.	Usually a progress bar is only displayed if STD-
	    OUT  and STDERR are detected to be TTY.  With this option a progress
	    bar is always shown.  Note that a progress bar will never  be  shown
	    when reading from STDIN or a pipe.

     --no-progress
	    Do	not  show  progress bar.  Usually a progress bar is displayed if
	    STDOUT and STDERR are detected to be a TTY.  With  this  option  the
	    progress  bar is suppressed.  Note that a progress bar will never be
	    shown when reading from STDIN or a pipe.

INPUT OPTIONS
     -F, --input-format=FORMAT
	    The format of the input file(s).  Can be used to set the input  for-
	    mat  if  it  can't be autodetected from the file name(s).  This will
	    set the format for all input files, there is no way to set the  for-
	    mat  for  some  input files only.  See osmium-file-formats(5) or the
	    libosmium manual for details.

DIAGNOSTICS
     osmium create-locations-index exits with exit code

     0	    if everything went alright,

     1	    if there was an error processing the data, or

     2	    if there was a problem with the command line arguments.

MEMORY USAGE
     osmium create-locations-index will not use a lot of memory.

EXAMPLES
     Create node locations index from planet:

	    osmium create-locations-index -i locations.idx planet.osm.pbf

     Set a node location in the index using an input file in OPL format:

	    echo "n123 x-80.6042 y28.6083" | \
		osmium create-locations-index -i locations.idx -F opl --update

SEE ALSO
     * osmium(1), osmium-query-locations-index(1), osmium-file-formats(5)

     * Osmium website

     * osm2pgsql

COPYRIGHT
     Copyright (C) 2013-2026 Jochen Topf <jochen@topf.org>.

     License  GPLv3+:  GNU  GPL  version   3   or   later   <https://gnu.org/li-
     censes/gpl.html>.	This is free software: you are free to change and redis-
     tribute it.  There is NO WARRANTY, to the extent permitted by law.

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

AUTHORS
     Jochen Topf <jochen@topf.org>.

				     1.19.0	OSMIUM-CREATE-LOCATIONS-INDEX(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=osmium-create-locations-index&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help