[osgearth] 11/15: Add man pages for new executables.

Bas Couwenberg sebastic at xs4all.nl
Sun Oct 26 16:19:43 UTC 2014


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

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

commit ebeccf0745851d71a8cfb28cb3d56fcd50826176
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date:   Tue Oct 14 00:37:44 2014 +0200

    Add man pages for new executables.
---
 debian/changelog                |   1 +
 debian/man/osgearth_atlas.1.xml | 124 ++++++++++++++++++++++++++++++++++++++++
 debian/man/osgearth_conv.1.xml  |  89 ++++++++++++++++++++++++++++
 debian/osgearth.manpages        |   2 +
 4 files changed, 216 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 2741a0d..d718989 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,6 +7,7 @@ osgearth (2.6.0+dfsg-1) UNRELEASED; urgency=medium
   * Drop lintian overrides for no-upstream-changelog,
     shouldn't override pedantic tags.
   * Bump SOVERSION to 4.
+  * Add man pages for new executables.
 
  -- Bas Couwenberg <sebastic at xs4all.nl>  Mon, 13 Oct 2014 20:54:22 +0200
 
diff --git a/debian/man/osgearth_atlas.1.xml b/debian/man/osgearth_atlas.1.xml
new file mode 100644
index 0000000..f7e0a5d
--- /dev/null
+++ b/debian/man/osgearth_atlas.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='osgearth_atlas'>
+
+  <refmeta>
+    <refentrytitle>osgearth_atlas</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>osgearth_atlas</refname>
+    <refpurpose>compile an osgEarth resource catalog into a texture atlas</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>osgearth_atlas</command>
+      <group>
+        <arg choice='opt'><option>--build</option> <replaceable>catalog.xml</replaceable></arg>
+        <arg choice='opt'><option>--size</option> <replaceable>x</replaceable> <replaceable>y</replaceable></arg>
+        <arg choice='opt'><option>--out-image</option> <replaceable>path</replaceable></arg>
+        <arg choice='opt'><option>--aux</option> <replaceable>pattern</replaceable> <replaceable>r</replaceable> <replaceable>g</replaceable> <replaceable>b</replaceable> <replaceable>a</replaceable></arg>
+      </group>
+      <group>
+        <arg choice='opt'><option>--show</option> <replaceable>catalog.xml</replaceable></arg>
+        <arg choice='opt'><option>--layer</option> <replaceable>num</replaceable></arg>
+        <arg choice='opt'><option>--labels</option></arg>
+        <arg choice='opt'><option>--aux</option> <replaceable>pattern</replaceable></arg>
+      </group>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'>
+    <title>DESCRIPTION</title>
+    <para>
+      <command>osgearth_atlas</command> will compile an osgEarth resource
+      catalog into a texture atlas.
+    </para>
+  </refsect1>
+
+  <refsect1 id='options'>
+    <title>OPTIONS</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><option>--build</option> <replaceable>catalog.xml</replaceable></term>
+        <listitem>
+          <para>Build an atlas from the catalog</para>
+
+          <variablelist>
+            <varlistentry>
+              <term><option>--size</option> <replaceable>x</replaceable> <replaceable>y</replaceable></term>
+              <listitem>
+                <para>Maximum size of atlas textures</para>
+              </listitem>
+            </varlistentry>
+        
+            <varlistentry>
+              <term><option>--out-image</option> <replaceable>path</replaceable></term>
+              <listitem>
+                <para>
+                  Output path for the atlas image (defaults to an OSGB file in
+                  the working directory).
+                  The paths in the resulting catalog file will point to this
+                  location using a relative path if possible. Output path for
+                  the atlas image (defaults to an OSGB file in the working
+                  directory). The paths in the resulting catalog file will
+                  point to this location using a relative path if possible.
+                </para>
+              </listitem>
+            </varlistentry>
+        
+            <varlistentry>
+              <term><option>--aux</option> <replaceable>pattern</replaceable> <replaceable>r</replaceable> <replaceable>g</replaceable> <replaceable>b</replaceable> <replaceable>b</replaceable> <replaceable>a</replaceable></term>
+              <listitem>
+                <para>
+                  Build an auxiliary atlas for files matching the pattern
+                  "filename_pattern.ext", e.g., "texture.jpg" will match
+                  "texture_NML.jpg" for pattern = "NML". The RGBA are the
+                  default values to use when no match is found.
+                </para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--show</option> <replaceable>catalog.xml</replaceable></term>
+        <listitem>
+          <para>Display an atlas built with this tool</para>
+
+          <variablelist>
+            <varlistentry>
+              <term><option>--layer</option> <replaceable>num</replaceable></term>
+              <listitem>
+                <para>Show layer <replaceable>num</replaceable> of the atlas (default = 0)</para>
+              </listitem>
+            </varlistentry>
+      
+            <varlistentry>
+              <term><option>--labels</option></term>
+              <listitem>
+                <para>Label each atlas entry</para>
+              </listitem>
+            </varlistentry>
+      
+            <varlistentry>
+              <term><option>--aux</option> <replaceable>pattern</replaceable></term>
+              <listitem>
+                <para>Show atlas matching this auxiliary file pattern</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+</refentry>
diff --git a/debian/man/osgearth_conv.1.xml b/debian/man/osgearth_conv.1.xml
new file mode 100644
index 0000000..a2ad6ce
--- /dev/null
+++ b/debian/man/osgearth_conv.1.xml
@@ -0,0 +1,89 @@
+<?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='osgearth_conv'>
+
+  <refmeta>
+    <refentrytitle>osgearth_conv</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>osgearth_conv</refname>
+    <refpurpose>convert tiles from one format to another</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>osgearth_conv</command>
+      <arg choice='opt'><option>--in</option> <replaceable>prop_name</replaceable> <replaceable>prop_value</replaceable></arg>
+      <arg choice='opt'><option>--out</option> <replaceable>prop_name</replaceable> <replaceable>prop_value</replaceable></arg>
+      <arg choice='opt'><option>--elevation</option></arg>
+      <arg choice='opt'><option>--profile</option> <replaceable>profile def</replaceable></arg>
+      <arg choice='opt'><option>--min-level</option> <replaceable>int</replaceable></arg>
+      <arg choice='opt'><option>--max-level</option> <replaceable>int</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'>
+    <title>DESCRIPTION</title>
+    <para>
+      <command>osgearth_conv</command> converts tiles from one format to
+      another.
+    </para>
+  </refsect1>
+
+  <refsect1 id='options'>
+    <title>OPTIONS</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><option>--in</option> <replaceable>prop_name</replaceable> <replaceable>prop_value</replaceable></term>
+        <listitem>
+          <para>set an input property</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--out</option> <replaceable>prop_name</replaceable> <replaceable>prop_value</replaceable></term>
+        <listitem>
+          <para>set an output property</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--elevation</option></term>
+        <listitem>
+          <para>
+            convert as elevation data (default is image)
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--profile</option> <replaceable>profile def</replaceable></term>
+        <listitem>
+          <para>
+            set an output profile (optional; default = same as input)
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--min-level</option> <replaceable>level</replaceable></term>
+        <listitem>
+          <para>minimum level of detail</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--max-level</option> <replaceable>level</replaceable></term>
+        <listitem>
+          <para>maximum level of detail</para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+</refentry>
diff --git a/debian/osgearth.manpages b/debian/osgearth.manpages
index 8772d99..529755e 100644
--- a/debian/osgearth.manpages
+++ b/debian/osgearth.manpages
@@ -1,6 +1,8 @@
+debian/man/osgearth_atlas.1
 debian/man/osgearth_backfill.1
 debian/man/osgearth_boundarygen.1
 debian/man/osgearth_cache.1
+debian/man/osgearth_conv.1
 debian/man/osgearth_demo.1
 debian/man/osgearth_overlayviewer.1
 debian/man/osgearth_package.1

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



More information about the Pkg-grass-devel mailing list