From b7fe90c8877f5ea0ff35b5da98e028f9474c7085 Mon Sep 17 00:00:00 2001 From: Kai Krueger Date: Sat, 20 Apr 2013 20:49:11 -0600 Subject: [PATCH] Add man page for openstreetmap-tiles-update-expire --- docs/openstreetmap-tiles-update-expire.1 | 46 ++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/openstreetmap-tiles-update-expire.1 diff --git a/docs/openstreetmap-tiles-update-expire.1 b/docs/openstreetmap-tiles-update-expire.1 new file mode 100644 index 0000000..b1348fb --- /dev/null +++ b/docs/openstreetmap-tiles-update-expire.1 @@ -0,0 +1,46 @@ +.TH TILES-UPDATE-EXPIRE 1 "Apr 20, 2013" +.\" Please adjust this date whenever revising the manpage. +.SH NAME +openstreetmap-tiles-update-expire \- updates a map database from the OSM diff stream. +.SH SYNOPSIS +.B openstreetmap-tiles-update-expire +.RI [ YYYY-MM-DD ] +.br +.SH DESCRIPTION +This manual page documents briefly the +.B openstreetmap-tiles-update-expire +command. +.PP +.B openstreetmap-tiles-update-expire +is a helper script to keep a mod_tile based openstreetmap tile server up to date. +It downloads a diff stream from OpenStreetMap using osmosis, then applies it to your database +using osm2pgsql and finally marks changed tiles on disk as "dirty". +.br +Each time you call this script, it does one update cycle. If your db is further behind than +the maximum duration for which osmosis is configured to fetch diffs, the db will not be fully +up-to-date at the end of this script and it will be necessary to call it multiple times for a fully +up-to-date database. +.br +This script can be used in conjunction with cron to automatically keep your database in sync with +the OSM diff stream. +.PP +The first time this script needs to be called with a date to initialise the process. Thereafter, +the script gets called without arguments. +.PP +.SH OPTIONS +.TP +\fBYYYY-MM-DD +generation date of the planet file used for import. It initialises osmosis diff processing to this date. +It is safe to set this date earlier than the actual date, as one can reapply diffs multiple times. This +ensures that there is no missing data due to a gap between the generation of the planet file and +the start of the diff processing. + +.PP +.SH SEE ALSO +.BR renderd (8), +.BR mod_tile (1). +.br +.SH AUTHOR +openstreetmap-tiles-update-expire was written by OpenStreetMap project members. +.PP +This manual page was written by OpenStreetMap authors.