mapcache_seed(1)

NAME
mapcache_seed - generate tiles to seed mapcache

SYNOPSIS
mapcache_seed
-c /path/to/mapcache.xml [options]

DESCRIPTION
mapcache_seed is an advanced seeding tool for mapcache, whose main features are:

•   configurable number of seeding threads, to speed up the rendering

•   ability to reseed tiles older than a certain timestamp

•   ability to seed tiles given a shapefile/OGR datasource

OPTIONS

\FC-c\F[], \FC--config\F[] file
    Path to the mapcache.xml configuration file that contains the tilesets that need to be seeded.

\FC-C\F[], \FC--cache\F[] override
    Override cache used by selected tileset (useful for selectively seeding fallback/multitier caches).

\FC-t\F[], \FC--tileset\F[] name
    Name of the tileset that must be seeded.

\FC-g\F[], \FC--grid\F[] name
    Name of the grid that must be seeded (the selected tileset must reference the given grid).

\FC-z\F[], \FC--zoom\F[] minzoom,maxzoom
    (Optional) Start and end zoom levels that must be seeded, separated by a comma, e.g. 0,6.

\FC-M\F[], \FC--metasize\F[] width,height
    Override metatile size while seeding, e.g. 8,8.

\FC-e\F[], \FC--extent\F[] minx,miny,maxx,maxy
    (Optional) Bounding box of the area to seed.

\FC-o\F[], \FC--older\F[] timestamp|now
    (Optional) Only seed tiles that are older than the given value. The value can either be the string "now", or a date formatted like year/month/day hour:minute, e.g.: "2011/01/31 20:45". (Note that a full timestamp should be quoted).

\FC-n\F[], \FC--nthreads\F[] number
    Number of parallel threads that should be used to request tiles from the WMS source. The default is 1, but can be set higher if the WMS server can withstand parallel requests (as a rule of thumb, the value chosen here should never be much higher than the number of cpus on the WMS server). (Incompatible with \FC-p\F[]/\FC--nprocesses\F[]).

\FC-p\F[], \FC--nprocesses\F[] number
    Number of parallel processes that should be used to request tiles from the WMS source. (Incompatible with \FC-n\F[]/\FC--nthreads\F[]).

\FC-P\F[], \FC--precent\F[] number
    Percent of failed requests allowed from the last 1000 before we abort (default: 1%, set to 0 to abort on first error).

\FC-L\F[], \FC--log-failed\F[] file
    Log failed tiles to file.

\FC-R\F[], \FC--retry-failed\F[] file
    Rtry failed requests logged to file by \FC--log-failed\F[].

\FC-m\F[], \FC--mode\F[] seed|delete|transfer
    Mode the utility will be running in: either seed (default), delete or transfer.

\FC-x\F[], \FC--transfer\F[] tileset
    Name of tileset to transfer.

\FC-D\F[], \FC--dimension\F[] DIMENSION=VALUE
    Used to specify which dimension to use if the tileset supports dimensions. Can be used multiple times to set multiple dimensions, e.g. \FC-D\F[] "DIM1=VAL1" \FC-D\F[] "DIM2=VAL2".

\FC-h\F[], \FC--help\F[]
    Show help.

\FC-q\F[], \FC--quiet\F[]
    Don't print progress messages to the standard output.

\FC-f\F[], \FC--force\F[]
    Force tile recreation even if it already exists.

\FC-v\F[], \FC--verbose\F[]
    Print verbose debugging info (if compiled in).

Optional Commandline options when using OGR/GEOS.

At compile time, if OGR and GEOS where found on the system, the seeder tool supports additional options to seed only the tiles that cover an arbitrary geographical area.

Important: Note that for the time being, the OGR datasource should be in the same projection as the grid you are seeding, as there is no automatic reprojection from the datasource projection to the grid projection.

\FC-d\F[], \FC--ogr-datasource\F[] datasource
    OGR connection to the spatial source. Consult the OGR documentation for all that is supported. In the simplest case (e.g. a Shapefile), this is just the full filename of the shapefile.

\FC-l\F[], \FC--ogr-layer\F[] layer
    (Optional) For datasources that contain multiple layers (e.g. postgis, with multiple tables), determines which layer will be used.

\FC-s\F[], \FC--ogr-sql\F[] SQL
    OGR sql expression that can be applied (see http://www.gdal.org/ogr/ogr_sql.html).

\FC-w\F[], \FC--ogr-where\F[] where
    SQL "where" expression to filter out returned values. This would typically be used to select only the geometry of a given country if the datasource contains all the world contours.

NOTES
The seeding utility must be run under the same user account as the user running the webserver. This is required so the permissions on the tiles created by the seeder are accessible by the webserver, and conversely so the seeder has the rights to write files to directories created by the webserver.

A sample seeding session goes like this:

\FC
        [user@host]$ sudo www-data
        [www-data@host]$ mapcache_seed -c /path/to/www/conf/mapcache.xml [options]
        [www-data@host]$ logout
        [user@host]$
      \F[]

EXAMPLE
Seed the "osm" tileset with the "g"(google/web-mercator) grid:

\FC
        mapcache_seed -c mapcache.xml -t osm -g g
      \F[]

Seed levels 0 through 12:

\FC
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12
      \F[]

Given a shapefile that contains the world country contours, seed only the areas that are covered by land (i.e. skip the oceans). Also use 4 request threads in parallel:

\FC
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp
      \F[]

Same as beforehand, but only seed the USA (notice the quote usage, required to create valid sql with a single-quoted 'US':

\FC
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp -w "FIPS_A2='US'"
      \F[]

Reseed levels 0 to 12 (this could also be done by deleting the cache for levels 0 to 12 and doing a classic seed, but doing so this way does not slow down the access from web clients):

\FC
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -o now
      \F[]