[nik4] 07/10: Add manpage for nik4.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Sun May 29 17:35:03 UTC 2016
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository nik4.
commit a3f73110f7cdee88bc60b41f0a53481ab83fe7cd
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sun May 29 18:32:21 2016 +0200
Add manpage for nik4.
---
debian/control | 6 +-
debian/man/nik4.1.xml | 366 ++++++++++++++++++++++++++++++++++++++++++++++++++
debian/manpages | 1 +
debian/rules | 13 ++
4 files changed, 385 insertions(+), 1 deletion(-)
diff --git a/debian/control b/debian/control
index 664d43f..80121bd 100644
--- a/debian/control
+++ b/debian/control
@@ -6,7 +6,11 @@ Uploaders: Bas Couwenberg <sebastic at debian.org>
Build-Depends: debhelper (>= 9),
dh-python,
python-all-dev,
- python-mapnik
+ python-mapnik,
+ docbook2x,
+ docbook-xsl,
+ docbook-xml,
+ xsltproc
Standards-Version: 3.9.8
Vcs-Browser: https://anonscm.debian.org/cgit/pkg-grass/nik4.git/
Vcs-Git: https://anonscm.debian.org/git/pkg-grass/nik4.git
diff --git a/debian/man/nik4.1.xml b/debian/man/nik4.1.xml
new file mode 100644
index 0000000..8fc91ed
--- /dev/null
+++ b/debian/man/nik4.1.xml
@@ -0,0 +1,366 @@
+<?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='nik4'>
+
+ <refmeta>
+ <refentrytitle>nik4</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>nik4</refname>
+ <refpurpose>Tile-aware Mapnik image renderer</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>nik4</command>
+ <arg choice='opt'><option>-h</option></arg>
+ <arg choice='opt'><option>--version</option></arg>
+ <arg choice='opt'><option>-z</option> <replaceable>ZOOM</replaceable></arg>
+ <arg choice='opt'><option>-p</option> <replaceable>PPI</replaceable></arg>
+ <arg choice='opt'><option>--factor</option> <replaceable>FACTOR</replaceable></arg>
+ <arg choice='opt'><option>-s</option> <replaceable>SCALE</replaceable></arg>
+ <arg choice='opt'><option>-b</option> <replaceable>Xmin Ymin Xmax Ymax</replaceable></arg>
+ <arg choice='opt'><option>-a</option> <replaceable>PAPER</replaceable></arg>
+ <arg choice='opt'><option>-d</option> <replaceable>W H</replaceable></arg>
+ <arg choice='opt'><option>-x</option> <replaceable>W H</replaceable></arg>
+ <arg choice='opt'><option>--norotate</option></arg>
+ <arg choice='opt'><option>-m</option> <replaceable>MARGIN</replaceable></arg>
+ <arg choice='opt'><option>-c</option> <replaceable>X Y</replaceable></arg>
+ <arg choice='opt'><option>--fit</option> <replaceable>FIT</replaceable></arg>
+ <arg choice='opt'><option>--padding</option> <replaceable>PADDING</replaceable></arg>
+ <arg choice='opt'><option>--layers</option> <replaceable>LAYERS</replaceable></arg>
+ <arg choice='opt'><option>--add-layers</option> <replaceable>ADD_LAYERS</replaceable></arg>
+ <arg choice='opt'><option>--hide-layers</option> <replaceable>HIDE_LAYERS</replaceable></arg>
+ <arg choice='opt'><option>--url</option> <replaceable>URL</replaceable></arg>
+ <arg choice='opt'><option>--ozi</option> <replaceable>OZI</replaceable></arg>
+ <arg choice='opt'><option>--wld</option> <replaceable>WLD</replaceable></arg>
+ <arg choice='opt'><option>-t</option> <replaceable>{1,2,3,4,5,6,7,8,9,10,11,12}</replaceable></arg>
+ <arg choice='opt'><option>--just-tiles</option></arg>
+ <arg choice='opt'><option>-v</option></arg>
+ <arg choice='opt'><option>-f</option> <replaceable>FMT</replaceable></arg>
+ <arg choice='opt'><option>--base</option> <replaceable>BASE</replaceable></arg>
+ <arg choice='opt'><option>--vars</option> <replaceable>[VARS [VARS ...]]</replaceable></arg>
+ <arg choice='opt'><option>--fonts</option> <replaceable>[FONTS [FONTS ...]]</replaceable></arg>
+ <arg choice='plain'><replaceable>style</replaceable></arg>
+ <arg choice='plain'><replaceable>output</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>nik4</command> is a Python script to generate images with Mapnik.
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+
+ <para>
+ Positional arguments:
+ </para>
+ <variablelist>
+
+ <varlistentry>
+ <term><replaceable>style</replaceable></term>
+ <listitem>
+ <para>
+ Style file for Mapnik
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><replaceable>output</replaceable></term>
+ <listitem>
+ <para>
+ Resulting image file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>
+ Optional arguments:
+ </para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>
+ Show usage information and exit
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--version</option></term>
+ <listitem>
+ <para>
+ Show program's version number and exit
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-z</option> <replaceable>ZOOM</replaceable></term>
+ <term><option>--zoom</option> <replaceable>ZOOM</replaceable></term>
+ <listitem>
+ <para>
+ Target zoom level
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-p</option> <replaceable>PPI</replaceable></term>
+ <term><option>--ppi</option> <replaceable>PPI</replaceable></term>
+ <term><option>--dpi</option> <replaceable>PPI</replaceable></term>
+ <listitem>
+ <para>
+ Pixels per inch (alternative to scale)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--factor</option> <replaceable>FACTOR</replaceable></term>
+ <listitem>
+ <para>
+ Scale factor (affects ppi, default=1)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s</option> <replaceable>SCALE</replaceable></term>
+ <term><option>--scale</option> <replaceable>SCALE</replaceable></term>
+ <listitem>
+ <para>
+ Scale as in 1:100000 (specifying ppi is recommended)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-b</option> <replaceable>Xmin Ymin Xmax Ymax</replaceable></term>
+ <term><option>--bbox</option> <replaceable>Xmin Ymin Xmax Ymax</replaceable></term>
+ <listitem>
+ <para>
+ Bounding box
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-a</option> <replaceable>PAPER</replaceable></term>
+ <term><option>--paper</option> <replaceable>PAPER</replaceable></term>
+ <listitem>
+ <para>
+ Paper format:
+ <option>-a</option> <literal>+4</literal> for landscape A4,
+ <option>-a</option> <literal>-4</literal> for portrait A4,
+ <option>-a</option> <literal>letter</literal> for autorotated
+ US Letter
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>W H</replaceable></term>
+ <term><option>--size</option> <replaceable>W H</replaceable></term>
+ <listitem>
+ <para>
+ Target dimensions in mm (one 0 allowed)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>W H</replaceable></term>
+ <term><option>--size-px</option> <replaceable>W H</replaceable></term>
+ <listitem>
+ <para>
+ Target dimensions in pixels (one 0 allowed)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--norotate</option></term>
+ <listitem>
+ <para>
+ Do not swap width and height for bbox
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-m</option> <replaceable>MARGIN</replaceable></term>
+ <term><option>--margin</option> <replaceable>MARGIN</replaceable></term>
+ <listitem>
+ <para>
+ Amount in mm to reduce paper size
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-c</option> <replaceable>X Y</replaceable></term>
+ <term><option>--center</option> <replaceable>X Y</replaceable></term>
+ <listitem>
+ <para>
+ Center of an image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--fit</option> <replaceable>FIT</replaceable></term>
+ <listitem>
+ <para>
+ Fit layers in the map, comma-separated
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--padding</option> <replaceable>PADDING</replaceable></term>
+ <listitem>
+ <para>
+ Margin for layers in <option>--fit</option> (default=5), mm
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--layers</option> <replaceable>LAYERS</replaceable></term>
+ <listitem>
+ <para>
+ Map layers to render, comma-separated
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add-layers</option> <replaceable>ADD_LAYERS</replaceable></term>
+ <listitem>
+ <para>
+ Map layers to include, comma-separated
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--hide-layers</option> <replaceable>HIDE_LAYERS</replaceable></term>
+ <listitem>
+ <para>
+ Map layers to hide, comma-separated
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--url</option> <replaceable>URL</replaceable></term>
+ <listitem>
+ <para>
+ URL of a map to center on
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ozi</option> <replaceable>OZI</replaceable></term>
+ <listitem>
+ <para>
+ Generate ozi map file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--wld</option> <replaceable>WLD</replaceable></term>
+ <listitem>
+ <para>
+ Generate world file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option> <replaceable>{1,2,3,4,5,6,7,8,9,10,11,12}</replaceable></term>
+ <term><option>--tiles</option> <replaceable>{1,2,3,4,5,6,7,8,9,10,11,12}</replaceable></term>
+ <listitem>
+ <para>
+ Write N×N tiles, then join using ImageMagick
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--just-tiles</option></term>
+ <listitem>
+ <para>
+ Do not join tiles, instead write ozi/wld file for each
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--debug</option></term>
+ <listitem>
+ <para>
+ Display calculated values
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>FMT</replaceable></term>
+ <term><option>--format</option> <replaceable>FMT</replaceable></term>
+ <listitem>
+ <para>
+ Target file format (by default looks at extension)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--base</option> <replaceable>BASE</replaceable></term>
+ <listitem>
+ <para>
+ Base path for style file, in case it's piped to STDIN
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--vars</option> <replaceable>[VARS [VARS ...]]</replaceable></term>
+ <listitem>
+ <para>
+ List of variables (name=value) to substitute in style file
+ (use ${name:default})
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--fonts</option> <replaceable>[FONTS [FONTS ...]]</replaceable></term>
+ <listitem>
+ <para>
+ List of full path to directories containing fonts
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+</refentry>
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..13cdaf4
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/man/*.1
diff --git a/debian/rules b/debian/rules
index dd82820..3fc9984 100755
--- a/debian/rules
+++ b/debian/rules
@@ -2,9 +2,22 @@
# DH_VERBOSE := 1
+BUILD_DATE=$(shell dpkg-parsechangelog | sed -ne 's/^Date: //p' | LC_ALL=C date -u "+%d %B %Y" -f -)
+
+MANPAGES := $(wildcard debian/man/*.*.xml)
+
%:
dh $@ --buildsystem=pybuild --with python2 --parallel
+override_dh_auto_build:
+ # Create man page from DocBook XML
+ for x in $(MANPAGES) ; do \
+ docbook2x-man --string-param header-3="$(BUILD_DATE)" $$x ; \
+ mv `basename $$x | sed 's/.xml$$//'` `dirname $$x` ; \
+ done
+
+ dh_auto_build
+
override_dh_install:
dh_install --list-missing
mv debian/nik4/usr/bin/nik4.py debian/nik4/usr/bin/nik4
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/nik4.git
More information about the Pkg-grass-devel
mailing list