[prepair] 01/02: Add man page for prepair.

Bas Couwenberg sebastic at xs4all.nl
Fri Nov 28 02:29:06 UTC 2014


This is an automated email from the git hooks/post-receive script.

sebastic-guest pushed a commit to branch master
in repository prepair.

commit 9fe3436d71b3942dc7c14cd34db08a7a85a7e4c1
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date:   Fri Nov 28 00:23:55 2014 +0100

    Add man page for prepair.
---
 debian/control           |   6 ++-
 debian/man/prepair.1.xml | 124 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/prepair.manpages  |   1 +
 debian/rules             |  14 ++++++
 4 files changed, 144 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index 8c7ad47..1c87e61 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/prepair.git/
 Vcs-Git: git://anonscm.debian.org/pkg-grass/prepair.git
diff --git a/debian/man/prepair.1.xml b/debian/man/prepair.1.xml
new file mode 100644
index 0000000..61f374f
--- /dev/null
+++ b/debian/man/prepair.1.xml
@@ -0,0 +1,124 @@
+<?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='prepair'>
+
+  <refmeta>
+    <refentrytitle>prepair</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>prepair</refname>
+    <refpurpose>repair GIS polygons</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>prepair</command>
+      <group>
+        <arg choice='plain'><option>--wkt</option> <replaceable>string</replaceable></arg>
+        <arg choice='plain'><option>-f</option> <replaceable>file</replaceable></arg>
+        <arg choice='plain'><option>--ogr</option> <replaceable>file</replaceable></arg>
+      </group>
+      <arg choice='opt'><option>--robustness</option></arg>
+      <arg choice='opt'><option>--minarea</option> <replaceable>AREA</replaceable></arg>
+      <arg choice='opt'><option>--isr</option> <replaceable>GRIDSIZE</replaceable></arg>
+      <arg choice='opt'><option>--time</option></arg>
+      <arg choice='opt'><option>--shpOut</option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'>
+    <title>DESCRIPTION</title>
+    <para>
+      <command>prepair</command> permits you to easily repair "broken" GIS
+      polygons, and that according to the international standards ISO 19107.
+      In brief, given a polygon stored in WKT, it automatically repairs it
+      and gives you back a valid WKT.
+      Automated repair methods can be considered as interpreting ambiguous or
+      ill-defined polygons and giving a coherent and clearly defined output.
+    </para>
+  </refsect1>
+
+  <refsect1 id='options'>
+    <title>OPTIONS</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><option>--wkt</option> <replaceable>'POLYGON(0 0, 1 0, 1 1, 0 0)'</replaceable></term>
+        <listitem>
+          <para>Process polygon from WKT string</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-f</option> <replaceable>infile.txt</replaceable></term>
+        <listitem>
+          <para>Process polygon from WKT string on the first line of the file</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--ogr</option> <replaceable>infile.shp</replaceable></term>
+        <listitem>
+          <para>Process first polygon of the input file</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--robustness</option></term>
+        <listitem>
+          <para>Compute the robustness of the input/output</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--setdiff</option></term>
+        <listitem>
+          <para>Uses the point set topology paradigm (default: odd-even paradigm)</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--minarea</option> <replaceable>AREA</replaceable></term>
+        <listitem>
+          <para>Only output polygons larger than <replaceable>AREA</replaceable></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--isr</option> <replaceable>GRIDSIZE</replaceable></term>
+        <listitem>
+          <para>Snap round the input before repairing</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--time</option></term>
+        <listitem>
+          <para>Benchmark the different stages of the process</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--shpOut</option></term>
+        <listitem>
+          <para>Output a shapefile (<filename>out.shp</filename>) instead of a WKT</para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1 id='see-also'>
+    <title>SEE ALSO</title>
+
+    <citerefentry>
+      <refentrytitle>pprepair</refentrytitle>
+      <manvolnum>1</manvolnum>
+    </citerefentry>
+
+  </refsect1>
+
+</refentry>
diff --git a/debian/prepair.manpages b/debian/prepair.manpages
new file mode 100644
index 0000000..d2e08a0
--- /dev/null
+++ b/debian/prepair.manpages
@@ -0,0 +1 @@
+debian/man/prepair.1
diff --git a/debian/rules b/debian/rules
index 440a381..6084bb6 100755
--- a/debian/rules
+++ b/debian/rules
@@ -2,6 +2,20 @@
 
 # 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
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/prepair.git



More information about the Pkg-grass-devel mailing list