[pprepair] 01/03: Add man page for pprepair.
Bas Couwenberg
sebastic at xs4all.nl
Fri Nov 28 17:27:27 UTC 2014
This is an automated email from the git hooks/post-receive script.
sebastic-guest pushed a commit to branch master
in repository pprepair.
commit 8c27e6c0435d9766a5c4d7ee472be38414e7f05a
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Nov 28 17:17:27 2014 +0100
Add man page for pprepair.
---
debian/control | 6 +-
debian/man/pprepair.1.xml | 336 ++++++++++++++++++++++++++++++++++++++++++++++
debian/pprepair.manpages | 1 +
debian/rules | 14 ++
4 files changed, 356 insertions(+), 1 deletion(-)
diff --git a/debian/control b/debian/control
index c2649ae..b127a23 100644
--- a/debian/control
+++ b/debian/control
@@ -6,7 +6,11 @@ Uploaders: Bas Couwenberg <sebastic at xs4all.nl>
Build-Depends: debhelper (>= 9),
cmake,
libcgal-dev,
- libgdal-dev
+ libgdal-dev,
+ docbook2x,
+ docbook-xsl,
+ docbook-xml,
+ xsltproc
Standards-Version: 3.9.6
Vcs-Browser: http://anonscm.debian.org/cgit/pkg-grass/pprepair.git/
Vcs-Git: git://anonscm.debian.org/pkg-grass/pprepair.git
diff --git a/debian/man/pprepair.1.xml b/debian/man/pprepair.1.xml
new file mode 100644
index 0000000..6f8445b
--- /dev/null
+++ b/debian/man/pprepair.1.xml
@@ -0,0 +1,336 @@
+<?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='pprepair'>
+
+ <refmeta>
+ <refentrytitle>pprepair</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pprepair</refname>
+ <refpurpose>planar partition repair tool</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pprepair</command>
+ <group>
+ <arg choice='opt'>
+ <arg choice='opt'><option>-i</option> <replaceable>filename</replaceable> <arg choice='opt'><replaceable>schemaindex</replaceable></arg></arg>
+ <arg choice='opt'><option>-o</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-fix</option></arg>
+ <arg choice='opt'><option>-d</option></arg>
+ </arg>
+ <arg choice='plain'><option>-p</option>
+ <arg choice='opt'><option>-i</option> <replaceable>filename</replaceable> [<replaceable>schemaindex</replaceable>]</arg>
+ <arg choice='opt'><option>-t</option></arg>
+ <arg choice='opt'><option>-otnt</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-vh</option></arg>
+ <arg choice='opt'><option>-sr</option> <replaceable>ratio</replaceable></arg>
+ <arg choice='opt'><option>-v</option></arg>
+ <arg choice='opt'><option>-au</option></arg>
+ <arg choice='opt'><option>-rtnn</option></arg>
+ <arg choice='opt'><option>-rtam</option></arg>
+ <arg choice='opt'><option>-rtlb</option></arg>
+ <arg choice='opt'><option>-rrlb</option></arg>
+ <arg choice='opt'><option>-rrrn</option></arg>
+ <arg choice='opt'><option>-rpl</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-rem</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-ot</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-otwp</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-bd</option></arg>
+ <arg choice='opt'><option>-rp</option></arg>
+ <arg choice='opt'><option>-owp</option></arg>
+ <arg choice='opt'><option>-o</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-pi</option></arg>
+ </arg>
+ </group>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pprepair</command> (planar partition repair) takes a set of
+ polygons and ensures that they form a valid planar partition, made of
+ valid polygons and having no gaps or overlaps.
+ It can be used as a validator, telling of problems in individual polygons
+ or in the planar partition, and also as an automatic repair tool,
+ outputting a set of polygons that do form a valid planar partition.
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <para>Basic options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-i</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Add this file to the triangulation using this schema index
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the reconstructed polygons in this file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-fix</option></term>
+ <listitem>
+ <para>
+ Automagically repair (same as <option>-rrlb</option>
+ <option>-rrrn</option>)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option></term>
+ <listitem>
+ <para>
+ Dissolve the boundaries between regions with the same tag
+ according to the schema index
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>Possible steps (in usual processing order)</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-i</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Add this file to the triangulation using this schema index
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option></term>
+ <listitem>
+ <para>
+ Tag the triangulation
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-otnt</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the tagged triangulation with the number of tags to this
+ file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-vh</option></term>
+ <listitem>
+ <para>
+ Consider holes as valid
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-sr</option> <replaceable>ration</replaceable></term>
+ <listitem>
+ <para>
+ Split invalid regions at triangles with a higher aspect ratio than
+ this
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <listitem>
+ <para>
+ Validate
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-au</option></term>
+ <listitem>
+ <para>
+ Allow removing invalid regions (where convenient)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rtnn</option></term>
+ <listitem>
+ <para>
+ Repair triangles by assigning them to the neighbour present on
+ most sides
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rtam</option></term>
+ <listitem>
+ <para>
+ Repair triangles by assigning them to a neighbour present on at
+ least 2 sides
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rtlb</option></term>
+ <listitem>
+ <para>
+ Repair triangles by assigning them to the neighbour present along
+ the longest part of their boundary
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rrlb</option></term>
+ <listitem>
+ <para>
+ Repair regions by assigning them to the neighbour present along
+ the longest part of their boundary
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rrrn</option></term>
+ <listitem>
+ <para>
+ Repair regions by assigning them to a random neighbour
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rpl</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Repair by assigning according to the priority list in this file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rem</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Repair for edge matching according to the priority list in this
+ file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ot</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the triangulation to this file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-otwp</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the triangulation to this file, including the input file
+ where each triangle came from
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-bd</option></term>
+ <listitem>
+ <para>
+ Removes unnecessary vertices before reconstruction to support
+ larger data sets (try if you get a segmentation fault)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rp</option></term>
+ <listitem>
+ <para>
+ Reconstruct polygons
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the reconstructed polygons in this file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-owp</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output the reconstructed polygons in this file, including the
+ input file where they came from
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-pi</option></term>
+ <listitem>
+ <para>
+ Print triangulation information
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <screen>
+<command>pprepair</command> <option>-i</option> "<filename>myInput.shp</filename>" <option>-o</option> "<filename>myOutput.shp</filename>" <option>-fix</option>
+ </screen>
+ </example>
+
+ </refsect1>
+
+ <refsect1 id='see-also'>
+ <title>SEE ALSO</title>
+
+ <citerefentry>
+ <refentrytitle>prepair</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>
+
+ </refsect1>
+
+</refentry>
diff --git a/debian/pprepair.manpages b/debian/pprepair.manpages
new file mode 100644
index 0000000..00d7bb6
--- /dev/null
+++ b/debian/pprepair.manpages
@@ -0,0 +1 @@
+debian/man/pprepair.1
diff --git a/debian/rules b/debian/rules
index 6c5e98f..0bdca0c 100755
--- a/debian/rules
+++ b/debian/rules
@@ -2,9 +2,23 @@
# DH_VERBOSE := 1
+MANPAGES:=$(wildcard debian/man/*.*.xml)
+
%:
dh $@
+override_dh_clean:
+ dh_clean debian/man/*.1
+
+override_dh_auto_build:
+ # Create man pages from DocBook XML
+ for x in $(MANPAGES) ; do \
+ docbook2x-man $$x ; \
+ mv `basename $$x | sed 's/.xml$$//'` `dirname $$x` ; \
+ done
+
+ dh_auto_build
+
get-orig-source:
. debian/get-orig-source
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pprepair.git
More information about the Pkg-grass-devel
mailing list