[pktools] 04/06: Add man page for pkdumpogr.
Bas Couwenberg
sebastic at xs4all.nl
Sat Dec 6 19:57:50 UTC 2014
This is an automated email from the git hooks/post-receive script.
sebastic-guest pushed a commit to branch master
in repository pktools.
commit 5f3a18ad2a6bb62d76c699e2e949eb9e16419864
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sat Dec 6 19:19:32 2014 +0100
Add man page for pkdumpogr.
---
debian/changelog | 2 +-
debian/man/pkdumpogr.1.xml | 192 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 193 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 8cecb08..c3e192e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -4,7 +4,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
* Refresh patches.
* Remove libbase package, library no longer installed.
* Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect,
- pkcrop, pkdiff, pkdsm2shadow, pkdumpimg.
+ pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkdumpogr.1.xml b/debian/man/pkdumpogr.1.xml
new file mode 100644
index 0000000..cb33ff5
--- /dev/null
+++ b/debian/man/pkdumpogr.1.xml
@@ -0,0 +1,192 @@
+<?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='pkdumpogr'>
+
+ <refmeta>
+ <refentrytitle>pkdumpogr</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkdumpogr</refname>
+ <refpurpose>dump ogr file to text file or standard output</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkdumpogr</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input.txt</replaceable></arg>
+ <arg choice='opt'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pkdumpogr</command> dumps the content of a vector dataset to
+ (standard) output (screen or filename).
+ The default is to dump all the attributes.
+ Individual attributes can be selected with the option
+ <option>-n</option>.
+ The X and Y positions can be printed with the option
+ <option>-pos</option>.
+ Use the option <option>-transpose</option> to transpose the output
+ (only in combination with the option <option>-n</option> attribute).
+ </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 shape file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <term><option>--output</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output ASCII file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ln</option> <replaceable>layername</replaceable></term>
+ <term><option>--lname</option> <replaceable>layername</replaceable></term>
+ <listitem>
+ <para>
+ Layer name(s) in sample (leave empty to select all)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-n</option> <replaceable>attribute</replaceable></term>
+ <term><option>--name</option> <replaceable>attribute</replaceable></term>
+ <listitem>
+ <para>
+ names of the attributes to select.
+ Each attribute is stored in a separate band.
+ Default is ALL: write all attributes
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-pos</option></term>
+ <term><option>--pos</option></term>
+ <listitem>
+ <para>
+ include position (x and y)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option></term>
+ <term><option>--transpose</option></term>
+ <listitem>
+ <para>
+ transpose output
+ (does not work for <option>-n</option> ALL)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ verbose (Default: 0)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <para>
+ Dump the attributes label and description for the vector dataset
+ <replaceable>sample.sqlite</replaceable> to standard output (screen)
+ </para>
+ <screen>
+<command>pkdumpogr</command> <option>-i</option> <replaceable>sample.sqlite</replaceable> <option>-n</option> <replaceable>label</replaceable> <option>-n</option> <replaceable>description</replaceable>
+
+0 2 noforest
+1 2 noforest
+2 2 noforest
+3 2 noforest
+4 2 noforest
+5 2 noforest
+6 2 noforest
+7 2 noforest
+8 2 noforest
+9 2 noforest
+10 1 forest
+11 2 noforest
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Similar to previous example, but transpose output (does not work
+ without explicitly defining options <option>-n</option> for attributes)
+ </para>
+ <screen>
+<command>pkdumpogr</command> <option>-i</option> <replaceable>sample.sqlite</replaceable> <option>-n</option> <replaceable>label</replaceable> <option>-n</option> <replaceable>description</replaceable> <option>-t</option>
+
+0 2 2 2 2 2 2 2 2 2 2 1 2
+1 noforest noforest noforest noforest noforest noforest noforest noforest noforest noforest forest noforest
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Dump the entire content of vector dataset
+ <replaceable>input.sqlite</replaceable> to standard output
+ </para>
+ <screen>
+<command>pkdumpogr</command> <option>-i</option> <replaceable>input.sqlite</replaceable>
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Dump only ATTRIBUTE of vector dataset
+ <replaceable>input.sqlite</replaceable> including x and y position and
+ output to ASCII file <replaceable>output.txt</replaceable>
+ </para>
+ <screen>
+<command>pkdumpogr</command> <option>-i</option> <replaceable>input.sqlite</replaceable> <option>-o</option> <replaceable>output.txt</replaceable> <option>-n</option> <replaceable>ATTRIBUTE</replaceable> <option>-pos</option>
+ </screen>
+ </example>
+
+ </refsect1>
+
+ <refsect1 id='see-also'>
+ <title>SEE ALSO</title>
+
+ <citerefentry>
+ <refentrytitle>pkascii2img</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>
+
+ </refsect1>
+
+</refentry>
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pktools.git
More information about the Pkg-grass-devel
mailing list