[pktools] 04/15: Add man page for pkpolygonize.

[Bas Couwenberg]

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

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

commit 5cd363ad7d8d122f4416fcbe5f85c019197189ea
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date:   Thu Dec 11 23:27:04 2014 +0100

    Add man page for pkpolygonize.
---
 debian/changelog              |   2 +-
 debian/man/pkpolygonize.1.xml | 126 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 127 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 4c9f374..db8d84a 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,7 +6,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
   * Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect,
     pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr, pkegcs, pkextract,
     pkfillnodata, pkfilter, pkfilterascii, pkfilterdem, pkfsann, pkfssvm,
-    pkgetmask, pkinfo, pklas2img, pkoptsvm.
+    pkgetmask, pkinfo, pklas2img, pkoptsvm, pkpolygonize.
 
  -- Bas Couwenberg <sebastic at xs4all.nl>  Wed, 03 Dec 2014 21:16:31 +0100
 
diff --git a/debian/man/pkpolygonize.1.xml b/debian/man/pkpolygonize.1.xml
new file mode 100644
index 0000000..56ab45e
--- /dev/null
+++ b/debian/man/pkpolygonize.1.xml
@@ -0,0 +1,126 @@
+<?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='pkpolygonize'>
+
+  <refmeta>
+    <refentrytitle>pkpolygonize</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>pkpolygonize</refname>
+    <refpurpose>program to make vector file from raster image</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>pkpolygonize</command>
+      <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+      <arg choice='opt'><option>-m</option> <replaceable>mask</replaceable></arg>
+      <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+      <arg choice='opt'><replaceable>options</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'>
+    <title>DESCRIPTION</title>
+    <para>
+      <command>pkpolygonize</command> converts a raster to a vector dataset.
+      All pixels in the mask band with a value other than zero will be
+      considered suitable for collection as polygons.
+      Use the same input file as mask to remove the background polygon
+      (recommended).
+    </para>
+  </refsect1>
+
+  <refsect1 id='options'>
+    <title>OPTIONS</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-i</option> <replaceable>filename</replaceable></term>
+        <term><option>--input</option> <replaceable>filename</replaceable></term>
+        <listitem>
+          <para>
+            Input image file
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-m</option> <replaceable>mask</replaceable></term>
+        <term><option>--mask</option> <replaceable>mask</replaceable></term>
+        <listitem>
+          <para>
+            All pixels in the mask band with a value other than zero will be
+            considered suitable for collection as polygons.
+            Use input file as mask to remove background polygon!
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option> <replaceable>filename</replaceable></term>
+        <term><option>--output</option> <replaceable>filename</replaceable></term>
+        <listitem>
+          <para>
+            Output vector file
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-f</option> <replaceable>format</replaceable></term>
+        <term><option>--f</option> <replaceable>format</replaceable></term>
+        <listitem>
+          <para>
+            Output OGR file format
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-b</option> <replaceable>band</replaceable></term>
+        <term><option>--band</option> <replaceable>band</replaceable></term>
+        <listitem>
+          <para>
+            band index(es) to crop (leave empty if all bands must be retained)
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-n</option> <replaceable>fieldname</replaceable></term>
+        <term><option>--name</option> <replaceable>fieldname</replaceable></term>
+        <listitem>
+          <para>
+            the field name of the output layer
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-nodata</option> <replaceable>value</replaceable></term>
+        <term><option>--nodata</option> <replaceable>value</replaceable></term>
+        <listitem>
+          <para>
+            Disgard this nodata value when creating polygons.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-v</option> <replaceable>level</replaceable></term>
+        <term><option>--verbose</option> <replaceable>level</replaceable></term>
+        <listitem>
+          <para>
+            verbose mode if > 0
+          </para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+    
+  </refsect1>
+
+</refentry>

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