The following commit has been merged in the master branch:
commit 79fe9f495118547bf333fb0e520b99bb5423fc8d
Author: Bas Couwenberg <sebas...@xs4all.nl>
Date:   Fri Jun 28 19:54:09 2013 +0200

    Add man page for mapcache_seed utility.

diff --git a/debian/changelog b/debian/changelog
index 5621c3d..53f41ac 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -14,6 +14,7 @@ mapcache (1.0.0-3) UNRELEASED; urgency=low
   * Build-Depend on libproj-dev instead of the proj source package.
   * Drop explicit dependency on libmapcache0, already set by shlibs:Depends.
   * Enable hardening build flags.
+  * Add man page for mapcache_seed utility.
   * Add patch to fix typos in demo service javascript.
   * Add patch to use a valid variable name for the WMSGetFeatureInfo control.
   * Add patch to set the HTML5 DOCTYPE in the demo service.
diff --git a/debian/control b/debian/control
index b253243..bd70a61 100644
--- a/debian/control
+++ b/debian/control
@@ -8,7 +8,8 @@ Build-Depends: debhelper (>= 9), dpkg-dev (>= 1.16.1.1), 
autotools-dev,
  libpcre3-dev, libpixman-1-dev, libfcgi-dev, libgdal1-dev, libgeos-dev,
  libsqlite3-dev, libtiff4-dev, libmapserver, libmapserver-dev,
  libgd-dev (>= 2.1.0~rc1-2), libproj-dev,
- autoconf, libfribidi-dev, libcairo2-dev, chrpath
+ autoconf, libfribidi-dev, libcairo2-dev, chrpath,
+ docbook2x, docbook-xsl, docbook-xml, xsltproc
 Standards-Version: 3.9.4
 Homepage: http://mapserver.org/trunk/mapcache/
 Vcs-Browser: http://git.debian.org/?p=pkg-grass/mapcache.git
diff --git a/debian/mapcache_seed.1.xml b/debian/mapcache_seed.1.xml
new file mode 100644
index 0000000..a3d92b3
--- /dev/null
+++ b/debian/mapcache_seed.1.xml
@@ -0,0 +1,324 @@
+<?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>
+
+  <!-- body begins here -->
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>mapcache_seed</command>
+      <arg choice='plain'>-c 
<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>-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 -p/--nprocesses).
+          </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 -n/--nthreads).
+          </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. -D "DIM1=VAL1" -D "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 countours, 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>
diff --git a/debian/rules b/debian/rules
index ebeb498..acf6ea7 100755
--- a/debian/rules
+++ b/debian/rules
@@ -38,6 +38,10 @@ override_dh_auto_configure:
        dh_auto_configure -- --with-mapserver=/usr/bin --with-fastcgi 
CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" CPPFLAGS="$(CPPFLAGS)"
 
 override_dh_auto_build:
+       # Create man page from DocBook XML
+       -docbook2x-man $(CURDIR)/debian/mapcache_seed.1.xml
+       -mv mapcache_seed.1 $(CURDIR)/debian/
+
        dh_auto_build
 
        # Make apache module

-- 
Packaging for MapCache

_______________________________________________
Pkg-grass-devel mailing list
Pkg-grass-devel@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-grass-devel

Reply via email to