File: mapcache_seed.1.xml

package info (click to toggle)
mapcache 1.10.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,760 kB
  • sloc: ansic: 32,573; xml: 843; sh: 143; makefile: 69; python: 48
file content (358 lines) | stat: -rw-r--r-- 12,717 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id='mapcache_seed'>

  <refmeta>
    <refentrytitle>mapcache_seed</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>mapcache_seed</refname>
    <refpurpose>generate tiles to seed mapcache</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>mapcache_seed</command>
      <arg choice='plain'><option>-c</option> <replaceable>/path/to/mapcache.xml</replaceable></arg>
      <arg choice='opt'><replaceable>options</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      <command>mapcache_seed</command> is an advanced seeding tool for mapcache, whose main features are:
      <itemizedlist>
        <listitem override='bullet'>configurable number of seeding threads, to speed up the rendering</listitem>
        <listitem override='bullet'>ability to reseed tiles older than a certain timestamp</listitem>
        <listitem override='bullet'>ability to seed tiles given a shapefile/OGR datasource</listitem>
      </itemizedlist>
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <variablelist>

      <varlistentry>
        <term><option>-c</option></term>
        <term><option>--config</option> <replaceable>file</replaceable></term>
        <listitem>
          <para>Path to the mapcache.xml configuration file that contains the tilesets that need to be seeded.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-C</option></term>
        <term><option>--cache</option> <replaceable>override</replaceable></term>
        <listitem>
          <para>Override cache used by selected tileset (useful for selectively seeding fallback/multitier caches).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t</option></term>
        <term><option>--tileset</option> <replaceable>name</replaceable></term>
        <listitem>
          <para>Name of the tileset that must be seeded.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g</option></term>
        <term><option>--grid</option> <replaceable>name</replaceable></term>
        <listitem>
          <para>Name of the grid that must be seeded (the selected tileset must reference the given grid).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-z</option></term>
        <term><option>--zoom</option> <replaceable>minzoom,maxzoom</replaceable></term>
        <listitem>
          <para>(Optional) Start and end zoom levels that must be seeded, separated by a comma, e.g. 0,6.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-M</option></term>
        <term><option>--metasize</option> <replaceable>width,height</replaceable></term>
        <listitem>
          <para>Override metatile size while seeding, e.g. 8,8.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-e</option></term>
        <term><option>--extent</option> <replaceable>minx,miny,maxx,maxy</replaceable></term>
        <listitem>
          <para>(Optional) Bounding box of the area to seed.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-o</option></term>
        <term><option>--older</option> <replaceable>timestamp|now</replaceable></term>
        <listitem>
          <para>
            (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).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option></term>
        <term><option>--nthreads</option> <replaceable>number</replaceable></term>
        <listitem>
          <para>
            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
            <option>-p</option>/<option>--nprocesses</option>).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p</option></term>
        <term><option>--nprocesses</option> <replaceable>number</replaceable></term>
        <listitem>
          <para>
            Number of parallel processes that should be used to request
            tiles from the WMS source. (Incompatible with
            <option>-n</option>/<option>--nthreads</option>).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-P</option></term>
        <term><option>--precent</option> <replaceable>number</replaceable></term>
        <listitem>
          <para>Percent of failed requests allowed from the last 1000 before we abort (default: 1%, set to 0 to abort on first error).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-L</option></term>
        <term><option>--log-failed</option> <replaceable>file</replaceable></term>
        <listitem>
          <para>Log failed tiles to <replaceable>file</replaceable>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-R</option></term>
        <term><option>--retry-failed</option> <replaceable>file</replaceable></term>
        <listitem>
          <para>Rtry failed requests logged to <replaceable>file</replaceable> by <option>--log-failed</option>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-m</option></term>
        <term><option>--mode</option> <replaceable>seed|delete|transfer</replaceable></term>
        <listitem>
          <para>Mode the utility will be running in: either seed (default), delete or transfer.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-x</option></term>
        <term><option>--transfer</option> <replaceable>tileset</replaceable></term>
        <listitem>
          <para>Name of tileset to transfer.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-D</option></term>
        <term><option>--dimension</option> <replaceable>DIMENSION=VALUE</replaceable></term>
        <listitem>
          <para>
            Used to specify which dimension to use if the tileset supports
            dimensions. Can be used multiple times to set multiple
            dimensions, e.g. <option>-D</option> "DIM1=VAL1"
            <option>-D</option> "DIM2=VAL2".
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Show help.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-q</option></term>
        <term><option>--quiet</option></term>
        <listitem>
          <para>Don't print progress messages to the standard output.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-f</option></term>
        <term><option>--force</option></term>
        <listitem>
          <para>Force tile recreation even if it already exists.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option></term>
        <term><option>--verbose</option></term>
        <listitem>
          <para>Print verbose debugging info (if compiled in).</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <formalpara>
      <title>Optional Commandline options when using OGR/GEOS</title>
    </formalpara>
    <para>
      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.
    </para>
    <para>
      <emphasis>Important:</emphasis> 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.
    </para>
    <variablelist>

      <varlistentry>
        <term><option>-d</option></term>
        <term><option>--ogr-datasource</option> <replaceable>datasource</replaceable></term>
        <listitem>
          <para>
            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.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-l</option></term>
        <term><option>--ogr-layer</option> <replaceable>layer</replaceable></term>
        <listitem>
          <para>
            (Optional) For datasources that contain multiple layers (e.g. postgis,
            with multiple tables), determines which layer will be used.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-s</option></term>
        <term><option>--ogr-sql</option> <replaceable>SQL</replaceable></term>
        <listitem>
          <para>OGR sql expression that can be applied (see http://www.gdal.org/ogr/ogr_sql.html).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-w</option></term>
        <term><option>--ogr-where</option> <replaceable>where</replaceable></term>
        <listitem>
          <para>
            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.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1 id='notes'>
    <title>NOTES</title>
    <para>
      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.
    </para>
    <para>
    A sample seeding session goes like this:
    </para>
    <informalexample>
      <screen>
        [user@host]$ sudo www-data
        [www-data@host]$ mapcache_seed -c /path/to/www/conf/mapcache.xml [options]
        [www-data@host]$ logout
        [user@host]$
      </screen>
    </informalexample>
  </refsect1>

  <refsect1 id='example'>
    <title>EXAMPLE</title>

    <informalexample>
      <para>Seed the "osm" tileset with the "g"(google/web-mercator) grid:</para>
      <screen>
        mapcache_seed -c mapcache.xml -t osm -g g
      </screen>
    </informalexample>

    <informalexample>
      <para>Seed levels 0 through 12:</para>
      <screen>
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12
      </screen>
    </informalexample>

    <informalexample>
      <para>
        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:
      </para>
      <screen>
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp
      </screen>
    </informalexample>

    <informalexample>
      <para>
        Same as beforehand, but only seed the USA (notice the quote usage,
        required to create valid sql with a single-quoted 'US':
      </para>
      <screen>
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp -w "FIPS_A2='US'"
      </screen>
    </informalexample>

    <informalexample>
      <para>
        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):
      </para>
      <screen>
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -o now
      </screen>
    </informalexample>

  </refsect1>

</refentry>