osmium-file-formats man page

osmium-file-formats — OSM file formats known to Osmium


The osmium command line tool supports all file formats supported by the Osmium library. These are:

The classical XML format in the variants .osm (for data files), .osh (for data files with history) and .osc (for change files).
The PBF binary format (usually with suffix .osm.pbf).
The OPL format (usually with suffix .osm.opl) (writing only).
The O5M/O5C format (usually with suffix .o5m or .o5c) (reading only).
The "debug" format (usually with suffix .osm.debug) (writing only).

In addition files in all formats except PBF can be compressed using gzip or bzip2. (Add .gz or .bz2 suffixes, respectively.)


Which format a file has is usually autodetected from the file name suffix.

If this doesn't work, either because you are reading from stdin or writing to stdout, or because you have an unusual file name, you have to set the format manually. You can also set the format manually if you want to specify special format options.

Most osmium commands support the --input-format (--F) and --output-format (-f) options to set the format. They take a comma-separated list of arguments, the first is the format, further arguments set additional options.

Special Format Options

The following options can be added when writing OSM files:

Enable/disable XML change format. Same as .osc.
force_visible_flag=true/false (default: false)
Force writing of visible flag, even for normal OSM XML files.
pbf_dense_nodes=true/false (default: true)
Enable/disable DenseNodes format for PBF files.
pbf_compression=true/false (default: true)
Enable/disable compression in PBF files. Disabling this will make writing files a bit faster, but the resulting files are 2 to 3 times bigger.
add_metadata=true/false (default: true)
Enable/disable writing of object metadata such as changeset id, username, etc. Disabling this will make files a bit smaller.


Here are some examples:

PBF format.
PBF format, dont' write metadata
XML format, compressed with bzip2.
OSM change file, compressed with gzip.
OSM change file, compressed with gzip.

See Also

Osmium website (http://osmcode.org/osmium)


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


Jochen Topf <jochen@topf.org>.

Referenced By

osmium(1), osmium-add-locations-to-ways(1), osmium-apply-changes(1), osmium-cat(1), osmium-changeset-filter(1), osmium-check-refs(1), osmium-derive-changes(1), osmium-diff(1), osmium-fileinfo(1), osmium-getid(1), osmium-merge(1), osmium-merge-changes(1), osmium-renumber(1), osmium-show(1), osmium-sort(1), osmium-time-filter(1).

Explore man page connections for osmium-file-formats(5).