This is an automated email from the git hooks/post-receive script. sebastic pushed a commit to branch master in repository osmcoastline.
commit 0216de8741c897191085974c98efd0f2e7fe5b46 Author: Bas Couwenberg <sebas...@xs4all.nl> Date: Fri Mar 13 16:38:49 2015 +0100 Add man pages for osmium utilities. --- debian/control | 6 +- debian/man/osmcoastline.1.xml | 173 +++++++++++++++++++++++++++++++++++ debian/man/osmcoastline_filter.1.xml | 81 ++++++++++++++++ debian/man/osmcoastline_ways.1.xml | 30 ++++++ debian/osmcoastline.manpages | 1 + debian/rules | 8 ++ 6 files changed, 298 insertions(+), 1 deletion(-) diff --git a/debian/control b/debian/control index a54c991..963cc09 100644 --- a/debian/control +++ b/debian/control @@ -14,7 +14,11 @@ Build-Depends: debhelper (>= 9), libspatialite-dev, zlib1g-dev, doxygen, - graphviz + graphviz, + docbook2x, + docbook-xsl, + docbook-xml, + xsltproc Standards-Version: 3.9.6 Vcs-Browser: http://anonscm.debian.org/cgit/pkg-grass/osmcoastline.git/ Vcs-Git: git://anonscm.debian.org/pkg-grass/osmcoastline.git diff --git a/debian/man/osmcoastline.1.xml b/debian/man/osmcoastline.1.xml new file mode 100644 index 0000000..f4f6ec4 --- /dev/null +++ b/debian/man/osmcoastline.1.xml @@ -0,0 +1,173 @@ +<?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='osmcoastline'> + + <refmeta> + <refentrytitle>osmcoastline</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>osmcoastline</refname> + <refpurpose>extract coastline from OSM data</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>osmcoastline</command> + <arg choice='opt'><replaceable>options</replaceable></arg> + <arg choice='plain'><replaceable>osmfile</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>osmcoastline</command> extracts the coastline from an OSM + planet file and assembles all the pieces into polygons for use in map + renderers etc. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term><option>-h</option></term> + <term><option>--help</option></term> + <listitem> + <para> + Display usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> <replaceable>DIST</replaceable></term> + <term><option>--close-distance</option>=<replaceable>DIST</replaceable></term> + <listitem> + <para> + Distance between nodes under which open rings are closed + (0 - disable closing of rings) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option> <replaceable>OVERLAP</replaceable></term> + <term><option>--bbox-overlap</option>=<replaceable>OVERLAP</replaceable></term> + <listitem> + <para> + Set overlap when splitting polygons + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-i</option></term> + <term><option>--no-index</option></term> + <listitem> + <para> + Do not create spatial indexes in output db + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option></term> + <term><option>--debug</option></term> + <listitem> + <para> + Enable debugging output + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option></term> + <term><option>--overwrite</option></term> + <listitem> + <para> + Overwrite output file if it already exists + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option></term> + <term><option>--output-lines</option></term> + <listitem> + <para> + Output coastlines as lines to database file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-m</option> <replaceable>NUM</replaceable></term> + <term><option>--max-points</option>=<replaceable>NUM</replaceable></term> + <listitem> + <para> + Split lines/polygons with more than this many points + (0 - disable splitting) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option> <replaceable>FILE</replaceable></term> + <term><option>--output-database</option>=<replaceable>FILE</replaceable></term> + <listitem> + <para> + Spatialite database file for output + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option> <replaceable>land|water|both|none</replaceable></term> + <term><option>--output-polygons</option>=<replaceable>land|water|both|none</replaceable></term> + <listitem> + <para> + Which polygons to write out (default: land) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-r</option></term> + <term><option>--output-rings</option></term> + <listitem> + <para> + Output rings to database file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option> <replaceable>EPSGCODE</replaceable></term> + <term><option>--srs</option>=<replaceable>EPSGCODE</replaceable></term> + <listitem> + <para> + Set SRS (4326 for WGS84 (default) or 3857) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option></term> + <term><option>--verbose</option></term> + <listitem> + <para> + Verbose output + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> diff --git a/debian/man/osmcoastline_filter.1.xml b/debian/man/osmcoastline_filter.1.xml new file mode 100644 index 0000000..825fe4a --- /dev/null +++ b/debian/man/osmcoastline_filter.1.xml @@ -0,0 +1,81 @@ +<?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='osmcoastline_filter'> + + <refmeta> + <refentrytitle>osmcoastline_filter</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>osmcoastline_filter</refname> + <refpurpose>extract coastline from OSM data</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>osmcoastline_filter</command> + <arg choice='opt'><replaceable>options</replaceable></arg> + <arg choice='plain'><replaceable>osmfile</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>osmcoastline_filter</command> can be used to filter from an OSM + planet file all nodes and ways needed for building the coastlines and + writing them out in OSM format. + This file will be a lot smaller (less than 1%) than the original planet + file, but it contains everything needed to assemble the coastline + polygons. + </para> + <para> + If you are playing around or want to run <command>osmcoastline</command> + several times with different parameters, run + <command>osmcoastline_filter</command> once first and use its output as + the input for osmcoastline. + </para> + <para> + Run it as follows: + <screen> +<command>osmcoastline_filter</command> <option>-o</option> <replaceable>OUTFILE.osm.pbf</replaceable> <replaceable>INFILE.osm.pbf</replaceable> + </screen> + </para> + <para> + <command>osmcoastline_filter</command> can read PBF and XML files, but + write only PBF files. + PBF files are much smaller and faster to read and write. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term><option>-h</option></term> + <term><option>--help</option></term> + <listitem> + <para> + Display usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option> <replaceable>OSMFILE</replaceable></term> + <term><option>--output</option>=<replaceable>OSMFILE</replaceable></term> + <listitem> + <para> + Where to write output (default: none) + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> diff --git a/debian/man/osmcoastline_ways.1.xml b/debian/man/osmcoastline_ways.1.xml new file mode 100644 index 0000000..01508c8 --- /dev/null +++ b/debian/man/osmcoastline_ways.1.xml @@ -0,0 +1,30 @@ +<?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='osmcoastline_ways'> + + <refmeta> + <refentrytitle>osmcoastline_ways</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>osmcoastline_ways</refname> + <refpurpose>extract coastline ways from OSM data</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>osmcoastline_ways</command> + <arg choice='plain'><replaceable>osmfile</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>osmcoastline_ways</command> can be used to extract coastline + ways from OSM data. + </para> + </refsect1> + +</refentry> diff --git a/debian/osmcoastline.manpages b/debian/osmcoastline.manpages new file mode 100644 index 0000000..13cdaf4 --- /dev/null +++ b/debian/osmcoastline.manpages @@ -0,0 +1 @@ +debian/man/*.1 diff --git a/debian/rules b/debian/rules index 49420ea..d6c3267 100755 --- a/debian/rules +++ b/debian/rules @@ -2,6 +2,8 @@ # DH_VERBOSE := 1 +MANPAGES := $(wildcard debian/man/*.*.xml) + %: dh $@ --buildsystem cmake \ --parallel @@ -10,6 +12,12 @@ override_dh_auto_configure: dh_auto_configure -- -DCMAKE_VERBOSE_MAKEFILE=1 override_dh_auto_build-arch: + # Create man page from DocBook XML + for x in $(MANPAGES) ; do \ + docbook2x-man $$x ; \ + mv `basename $$x | sed 's/.xml$$//'` `dirname $$x` ; \ + done + dh_auto_build --arch override_dh_auto_build-indep: -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/osmcoastline.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