.TH "OSMCOASTLINE_FILTER" "1" "2.4.0" "" ""
.SH NAME
.PP
osmcoastline_filter - filter coastline data from OpenStreetMap file
.SH SYNOPSIS
.PP
\f[B]osmcoastline_filter\f[R] --output=\f[I]OUTPUT_FILE\f[R]
\f[I]INPUT-FILE\f[R]
.PP
\f[B]osmcoastline_filter\f[R] --help
.SH DESCRIPTION
.PP
\f[B]osmcoastline_filter\f[R] is used to filter all nodes and ways
needed for building the coastlines from an OSM planet.
The data is written to the output file in PBF format.
.PP
This output file will be a lot smaller (less than 1%) than the original
planet file, but it contains everything needed to assemble the coastline
and land or water polygons.
.PP
If you are playing around or want to run \f[B]osmcoastline\f[R] several
times with different parameters, run \f[B]osmcoastline_filter\f[R] once
first and use its output as the input for \f[B]osmcoastline\f[R].
.PP
\f[B]osmcoastline_filter\f[R] can read any file format supported by
libosmium (in particular this is PBF, XML, and OPL files), but write
only PBF files.
PBF files are much smaller and faster to read and write than XML files.
The output file will first contain all ways tagged
\[lq]natural=coastline\[rq], then all nodes used for those ways (and all
nodes tagged \[lq]natural=coastline\[rq]).
Having the ways first and the nodes later in the file is unusual for OSM
files, but the \f[B]osmcoastline\f[R] and \f[B]osmcoastline_ways\f[R]
programs work fine with it.
.SH OPTIONS
.TP
-f, --format
Set output format options (default: pbf).
.TP
-h, --help
Display usage information and exit.
.TP
-o, --output=OSMFILE
Where to write output (default: none).
.TP
-v, --verbose
Enable verbose output.
.TP
-V, --version
Display program version and license information.
.SH EXAMPLES
.PP
Run it as follows:
.IP
.nf
\f[C]
osmcoastline_filter -o coastline-data.osm.pbf planet.osm.pbf
\f[R]
.fi
.SH SEE ALSO
.IP \[bu] 2
\f[B]osmcoastline\f[R](1), \f[B]osmcoastline_ways\f[R](1)
.IP \[bu] 2
Project page (https://osmcode.org/osmcoastline/)
.IP \[bu] 2
OSMCoastline in OSM
wiki (https://wiki.openstreetmap.org/wiki/OSMCoastline)
.SH COPYRIGHT
.PP
Copyright (C) 2012\-2021 Jochen Topf <jochen@topf.org>.
License GPLv3+: GNU GPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH CONTACT
.PP
If you have any questions or want to report a bug, please go to
https://osmcode.org/contact.html
.SH AUTHORS
Jochen Topf <jochen@topf.org>.