This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository librasterlite2.
commit 38262e7a7e2fd09f3385906b59bd364d3fd52c2c
Author: Bas Couwenberg <sebas...@xs4all.nl>
Date: Sat Jun 27 18:07:04 2015 +0200
Add man page for rl2sniff.
---
debian/changelog | 1 +
debian/man/rl2sniff.1.xml | 258 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 259 insertions(+)
diff --git a/debian/changelog b/debian/changelog
index df791ad..a26dcbd 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -11,6 +11,7 @@ librasterlite2 (1.0.0~rc0+devel-1) UNRELEASED; urgency=medium
* Bump minimum required libspatialite to 4.3.0~rc1.
* Add gbp.conf to use pristine-tar by default.
* Add patch to fix SOVERSION, was decremented from 1 to 0.
+ * Add man page for rl2sniff.
-- Bas Couwenberg <sebas...@debian.org> Sun, 21 Jun 2015 13:25:56 +0200
diff --git a/debian/man/rl2sniff.1.xml b/debian/man/rl2sniff.1.xml
new file mode 100644
index 0000000..184b59a
--- /dev/null
+++ b/debian/man/rl2sniff.1.xml
@@ -0,0 +1,258 @@
+<?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='rl2sniff'>
+
+ <refmeta>
+ <refentrytitle>rl2sniff</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>rl2sniff</refname>
+ <refpurpose>Sniffer tool for RasterLite2</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>rl2sniff</command>
+ <arg choice='opt'><replaceable>ARGLIST</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>rl2sniff</command> is a sniffer tool for RasterLite2.
+ Sometimes handling a relevant number of raster images (may be of
+ different origin and presenting different technical characteristics)
+ isn't an easy task, most notably when your images are dispersed into
+ many different folders.
+ The <command>rl2sniff</command> CLI tool is exactly intended to offer a
+ significant help in organizing and planning any preliminary activity
+ required in order to create and populate your RasterLite2's Coverages.
+ </para>
+ <para>
+ <command>rl2sniff</command> will examine files containing a raster image,
+ and will then create a report showing the more relevant characteristics
+ for each one; the supported arguments are the followings:
+ <itemizedlist>
+ <listitem>
+ <para>
+ arguments specifying the intended target:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <option>-src</option> <replaceable>pathname</replaceable>:
+ will examine just a single input raster image.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>-dir</option> <replaceable>pathname</replaceable>:
+ will explore a whole directory aka folder.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Please note: <option>-src</option> and <option>-dir</option>
+ are mutually exclusive options.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>-ext</option> <replaceable>extension</replaceable>:
+ combined with <option>-dir</option> will restrict the search
+ to a specific raster format.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ if no target is explicitly selected (e.g. when there are no
+ arguments at all) then the
+ <emphasis>current working directory</emphasis> will be
+ intended by default.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>-wf</option>: any georeferencing information will be
+ always retrieved from a companion
+ <ulink
url="http://en.wikipedia.org/wiki/World_file";>worldfile</ulink>.
+ </para>
+ <para>
+ Please note: in this case any georeferencing found in the
+ <replaceable>worldfile</replaceable> will always override any
+ other information eventually found e.g. within a GeoTIFF image.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>-md5</option>: the output report will include an
+ <ulink url="http://en.wikipedia.org/wiki/MD5";>MD5 checksum</ulink>
+ computed for each raster file.
+ </para>
+ <para>
+ Please note: computing the MD5 checksums could require a
+ substantial amount of time, most notably when many hundredth
+ huge-sized files are to be scanned.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <formalpara>
+ <title>the output report</title>
+ <para>
+ The report created by <command>rl2sniff</command> simply corresponds
+ to a TXT/TAB being printed on the stdout file.
+ </para>
+ <para>
+ The report's columns are as follows:
+ <itemizedlist>
+ <listitem>
+ <para>
+ columns always supported for both georeferenced and
+ non-georeferenced rasters:
+ <itemizedlist>
+ <listitem>
+ <para>
+ image_format: e.g. GeoTIFF, TIFF+TFW or ASCII Grid.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ MD5_checksum: may be NULL is the corresponding option
+ wasn't activated.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ image_path: the absolute path leading to the raster file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ width and height: horizontal and vertical dimensions
+ (in pixels).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ sample_type, pixel_type and bands: e.g. UINT8, RGB, 3.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ no_data: value corresponding to NO-DATA pixels
+ (currently supported only for ASCII Grids).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ compression: e.g. DEFLATE or FAX4; NONE if uncompressed.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ columns supported only for raster of the georeferenced type:
+ <itemizedlist>
+ <listitem>
+ <para>
+ srid: the declared SRID value; <literal>-1</literal> if
unknown / unspecified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ x_resolution and y_resolution: horizontal and vertical
+ pixel resolution.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ min_x, min_y, max_x and max_y: extreme points of the
+ raster's bounding box aka BBOX.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </formalpara>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>
+ print usage information
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-src</option> <replaceable>pathname</replaceable></term>
+ <term><option>--src-path</option>
<replaceable>pathname</replaceable></term>
+ <listitem>
+ <para>
+ single Image/Raster path
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dir</option> <replaceable>pathname</replaceable></term>
+ <term><option>--dir-path</option>
<replaceable>pathname</replaceable></term>
+ <listitem>
+ <para>
+ directory path
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ext</option> <replaceable>extension</replaceable></term>
+ <term><option>--file-ext</option>
<replaceable>extension</replaceable></term>
+ <listitem>
+ <para>
+ file extension (e.g. .tif)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-wf</option></term>
+ <term><option>--worldfile</option></term>
+ <listitem>
+ <para>
+ requires a Worldfile
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-md5</option></term>
+ <term><option>--md5-checksum</option></term>
+ <listitem>
+ <para>
+ enabling MD5 checksums
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+</refentry>
--
Alioth's /usr/local/bin/git-commit-notice on
/srv/git.debian.org/git/pkg-grass/librasterlite2.git
_______________________________________________
Pkg-grass-devel mailing list
Pkg-grass-devel@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-grass-devel
