'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH mapproxy-seed 1 "13 April 2023" "" ""
.SH NAME
mapproxy-seed \- pre-generate tiles for MapProxy
.SH SYNOPSIS
'nh
.fi
.ad l
\fBmapproxy-seed\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fIOPTIONS\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBmapproxy-seed\fR pre-generates tiles for MapProxy to
improve the performance for commonly requested views, because MapProxy
creates all tiles on demand otherwise.
.PP
The tool can seed one or more polygon or BBOX areas for each cached
layer.
.PP
MapProxy does not seed the tile pyramid level by level, but traverses
the tile pyramid depth-first, from bottom to top.
This is optimized to work with the caches of your operating system and
geospatial database, and not against.
.SH OPTIONS
.TP 
\*(T<\fB\-s\fR\*(T> \fIseed.yaml\fR, \*(T<\fB\-\-seed\-conf\fR\*(T> \fIseed.yaml\fR
The seed configuration.
You can also pass the configuration as the last argument to
\fBmapproxy-seed\fR.
.TP 
\*(T<\fB\-f\fR\*(T> \fImapproxy.yaml\fR, \*(T<\fB\-\-proxy\-conf\fR\*(T> \fImapproxy.yaml\fR
The MapProxy configuration to use.
This file should describe all caches and grids that the seed
configuration references.
.TP 
\*(T<\fB\-c\fR\*(T> \fIN\fR, \*(T<\fB\-\-concurrency\fR\*(T> \fIN\fR
The number of concurrent seed worker.
Some parts of the seed tool are CPU intensive (image splitting and
encoding), use this option to distribute that load across multiple
CPUs.
To limit the concurrent requests to the source WMS see
\*(T<wms_source_concurrent_requests_label\*(T>.
.TP 
\*(T<\fB\-n\fR\*(T>, \*(T<\fB\-\-dry\-run\fR\*(T>
This will simulate the seed/cleanup process without requesting,
creating or removing any tiles.
.TP 
\*(T<\fB\-\-summary\fR\*(T>
Print a summary of all seeding and cleanup tasks and exit.
.TP 
\*(T<\fB\-i\fR\*(T>, \*(T<\fB\-\-interactive\fR\*(T>
Print a summary of each seeding and cleanup task and ask if
\fBmapproxy-seed\fR should seed/cleanup that task.
It will query for each task before it starts.
.TP 
\*(T<\fB\-\-seed\fR\*(T> \fItask1,task2,..\fR
Only seed the named seeding tasks.
You can select multiple tasks with a list of comma separated names,
or you can use the \*(T<\fB\-\-seed\fR\*(T> option multiple times.
You can use \*(T<ALL\*(T> to select all tasks.
This disables all cleanup tasks unless you also use the
\*(T<\fB\-\-cleanup\fR\*(T> option.
.TP 
\*(T<\fB\-\-cleanup\fR\*(T> \fItask1,task2,..\fR
Only cleanup the named tasks.
You can select multiple tasks with a list of comma separated names,
or you can use the \*(T<\fB\-\-cleanup\fR\*(T> option multiple times.
You can use \*(T<ALL\*(T> to select all tasks.
This disables all seeding tasks unless you also use the
\*(T<\fB\-\-seed\fR\*(T> option.
.TP 
\*(T<\fB\-\-continue\fR\*(T>
Continue an interrupted seed progress.
MapProxy will start the seeding progress at the beginning if the
progress file (\*(T<\fB\-\-progress\-file\fR\*(T>) was not found.
MapProxy can only continue if the previous seed was started with
the \*(T<\fB\-\-progress\-file\fR\*(T> or
\*(T<\fB\-\-continue\fR\*(T> option.
.TP 
\*(T<\fB\-\-progress\-file\fR\*(T>
Filename where MapProxy stores the seeding progress for the
\*(T<\fB\-\-continue\fR\*(T> option.
Defaults to \*(T<.mapproxy_seed_progress\*(T> in the
current working directory.
MapProxy will remove that file after a successful seed.
.TP 
\*(T<\fB\-\-duration\fR\*(T>
Stop seeding process after this duration.
This option accepts duration in the following format:
120s, 15m, 4h, 0.5d
Use this option in combination with \*(T<\fB\-\-continue\fR\*(T> to
be able to resume the seeding.
.TP 
\*(T<\fB\-\-reseed\-file\fR\*(T>
File created by \fBmapproxy-seed\fR at the start of a
new seeding.
.TP 
\*(T<\fB\-\-reseed\-interval\fR\*(T>
Only start seeding if \*(T<\fB\-\-reseed\-file\fR\*(T> is older then
this duration.
This option accepts duration in the following format:
120s, 15m, 4h, 0.5d
Use this option in combination with \*(T<\fB\-\-continue\fR\*(T> to
be able to resume the seeding.
.TP 
\*(T<\fB\-\-use\-cache\-lock\fR\*(T>
Lock each cache to prevent multiple parallel
\fBmapproxy-seed\fR calls to work on the same cache.
It does not lock normal operation of MapProxy.
.TP 
\*(T<\fB\-\-log\-config\fR\*(T>
The logging configuration file to use.
.SH EXAMPLE
Seed with concurrency of 4:
.PP
.nf
\*(T<
\fBmapproxy\-seed\fR \fB\-f\fR mapproxy.yaml \fB\-c\fR 4 seed.yaml
    \*(T>
.fi
.PP
Print summary of all seed tasks and exit:
.PP
.nf
\*(T<
\fBmapproxy\-seed\fR \fB\-f\fR mapproxy.yaml \fB\-s\fR seed.yaml \fB\-\-summary\fR \fB\-\-seed\fR ALL
    \*(T>
.fi
.PP
Interactively select which tasks should be seeded:
.PP
.nf
\*(T<
\fBmapproxy\-seed\fR \fB\-f\fR mapproxy.yaml \fB\-s\fR seed.yaml \fB\-i\fR
    \*(T>
.fi
.PP
Seed task1 and task2 and cleanup task3 with concurrency of 2:
.PP
.nf
\*(T<
\fBmapproxy\-seed\fR \fB\-f\fR mapproxy.yaml \fB\-s\fR seed.yaml \fB\-c\fR 2 \fB\-\-seed\fR task1,task2 \e
 \fB\-\-cleanup\fR task3
    \*(T>
.fi