Skip to content

Commit 7945f6e

Browse files
committed
Update man page
1 parent ef4b6e6 commit 7945f6e

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

docs/man/tilemaker.1

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" Manpage for tilemaker.
2-
.TH man 1 "27 Aug 2021" "1.0" "tilemaker man page"
2+
.TH man 1 "10 Feb 2022" "1.0" "tilemaker man page"
33
.SH NAME
44
tilemaker \- Generates vector tiles from OpenStreetMap data
55
.SH SYNOPSIS
@@ -11,8 +11,10 @@ command.
1111
.PP
1212
.B tilemaker
1313
generates vector tiles from OpenStreetMap planet and diff files
14-
without any complex stack or need for database. It uses the schema of
15-
OpenMapTiles by default, but other configuration can be provided.
14+
without any complex stack or need for a database. It uses the schema of
15+
OpenMapTiles by default, but custom vector tiles can be produced by
16+
modifying the JSON config (layer config and general options) and Lua
17+
processing script (mapping OSM tags to vector tile layers/attributes).
1618
.PP
1719
This program follows the usual GNU command line syntax, with long
1820
options starting with two dashes (`-').
@@ -22,22 +24,36 @@ A summary of options is included below:
2224
Source path and file from OpenStreetMap (.osm.pbf).
2325
.TP
2426
\fB\-\-output
25-
Target path and file for vector tiles (.mbtiles/.sqlite).
27+
Target path for vector tiles. Specify .mbtiles/.sqlite to create
28+
an mbtiles archive, or a directory to create individual .mvt files.
2629
.TP
2730
\fB\-\-config
28-
Specific config file (.json).
31+
Path to layer and global config file (.json). config.json assumed if
32+
not specified.
2933
.TP
3034
\fB\-\-process
31-
Lua processing script for processing tags.
35+
Path to Lua processing script for processing tags. process.lua assumed if
36+
not specified.
3237
.TP
3338
\fB\-\-store
34-
Path to the directory as a temporary store during processing.
35-
If specifcied tilemaker uses on-disk storage instead of holding everything
36-
in RAM.
39+
Path to the directory to use as a temporary store during processing.
40+
If specified, tilemaker uses on-disk storage instead of holding everything
41+
in RAM. Fast storage (e.g. SSD) is strongly recommended.
42+
.TP
43+
\fB\-\-compact
44+
Reduce overall memory usage by assuming nodes are numbered sequentially
45+
(requires .osm.pbf to be pre-processed with osmium renumber).
3746
.TP
3847
\fB\-\-merge
3948
Merge with existing .mbtiles/.sqlite file.
4049
.TP
50+
\fB\-\-bbox
51+
Bounding box to use if the input file does not set one in the header
52+
(as minlon,minlat,maxlon,maxlat).
53+
.TP
54+
\fB\-\-skip\-integrity
55+
Don't enforce checks on all nodes being present in ways.
56+
.TP
4157
\fB\-\-verbose
4258
Outputs any issues encountered during tile creation.
4359
.TP

0 commit comments

Comments
 (0)