This is an automated email from the git hooks/post-receive script. sebastic pushed a commit to branch master in repository routino.
commit 0219804fc89bef1c78456e6bfe16f8f8944e2e34 Author: Bas Couwenberg <[email protected]> Date: Fri Feb 20 18:43:25 2015 +0100 Add man pages for routino utilities. --- debian/changelog | 2 + debian/control | 6 +- debian/man/filedumper-slim.1.xml | 407 ++++++++++++++++++++ debian/man/filedumper.1.xml | 407 ++++++++++++++++++++ debian/man/filedumperx.1.xml | 155 ++++++++ debian/man/planetsplitter-slim.1.xml | 346 +++++++++++++++++ debian/man/planetsplitter.1.xml | 405 ++++++++++++++++++++ debian/man/routino-router-slim.1.xml | 696 +++++++++++++++++++++++++++++++++++ debian/man/routino-router.1.xml | 696 +++++++++++++++++++++++++++++++++++ debian/routino.manpages | 1 + debian/rules | 14 + 11 files changed, 3134 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 93b0d77..a2b920f 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,6 +6,8 @@ routino (2.7.3-1) UNRELEASED; urgency=medium * Update copyright file using copyright-format 1.0. * Add upstream metadata. * Add substitution variable ${perl:Depends} to routino-www. + * Add man pages for routino utilities. + (closes: #704172) -- Bas Couwenberg <[email protected]> Fri, 06 Feb 2015 21:22:51 +0100 diff --git a/debian/control b/debian/control index de6ee2a..b4392fa 100644 --- a/debian/control +++ b/debian/control @@ -8,7 +8,11 @@ Priority: extra Build-Depends: debhelper (>= 9), flex, libbz2-dev, - zlib1g-dev + zlib1g-dev, + docbook2x, + docbook-xsl, + docbook-xml, + xsltproc Standards-Version: 3.9.6 Vcs-Browser: http://anonscm.debian.org/cgit/pkg-grass/routino.git Vcs-Git: git://anonscm.debian.org/pkg-grass/routino.git diff --git a/debian/man/filedumper-slim.1.xml b/debian/man/filedumper-slim.1.xml new file mode 100644 index 0000000..9f5e88c --- /dev/null +++ b/debian/man/filedumper-slim.1.xml @@ -0,0 +1,407 @@ +<?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='filedumper-slim'> + + <refmeta> + <refentrytitle>filedumper-slim</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>filedumper-slim</refname> + <refpurpose>dump routino database contents</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>filedumper-slim</command> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--statistics</option></arg> + <arg choice='opt'><option>--visualiser</option> + <arg choice='plain'><option>--latmin=<replaceable>latmin</replaceable></option></arg> + <arg choice='plain'><option>--latmax=<replaceable>latmax</replaceable></option></arg> + <arg choice='plain'><option>--lonmin=<replaceable>lonmin</replaceable></option></arg> + <arg choice='plain'><option>--lonmax=<replaceable>lonmax</replaceable></option></arg> + <arg choice='plain'><option>--data=<replaceable>data-type</replaceable></option></arg> + </arg> + <arg choice='opt'><option>--dump</option> + <arg choice='opt'><option>--node=<replaceable>node</replaceable></option> ...</arg> + <arg choice='opt'><option>--segment=<replaceable>segment</replaceable></option> ...</arg> + <arg choice='opt'><option>--way=<replaceable>way</replaceable></option> ...</arg> + <arg choice='opt'><option>--turn-relation=<replaceable>rel</replaceable></option> ...</arg> + <arg choice='opt'><option>--errorlog=<replaceable>number</replaceable></option> ...</arg> + </arg> + <arg choice='opt'><option>--dump-osm</option> + <arg choice='opt'><option>--no-super</option></arg> + <arg choice='opt'><option>--latmin=<replaceable>latmin</replaceable></option> + <arg choice='plain'><option>--latmax=<replaceable>latmax</replaceable></option></arg> + <arg choice='plain'><option>--lonmin=<replaceable>lonmin</replaceable></option></arg> + <arg choice='plain'><option>--lonmax=<replaceable>lonmax</replaceable></option></arg> + </arg> + </arg> + <arg choice='opt'><option>--dump-visualiser</option> + <arg choice='opt'><option>--data=node<node></option></arg> + <arg choice='opt'><option>--data=segment<segment></option></arg> + <arg choice='opt'><option>--data=turn-relation<rel></option></arg> + <arg choice='opt'><option>--data=errorlog<number></option></arg> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>filedumper-slim</command> is used to extract statistics from the + <command>routino</command> database, extract particular information for + visualisation purposes or for dumping the database contents. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + The directory containing the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + The filename prefix for the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--statistics</option></term> + <listitem> + <para> + Print statistics about the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--visualiser</option></term> + <listitem> + <para> + Extract selected data from the routing database: + </para> + <variablelist> + + <varlistentry> + <term><option>--latmin</option>=<replaceable>latmin</replaceable></term> + <listitem> + <para> + The minimum latitude (degrees N) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmax</option>=<replaceable>latmax</replaceable></term> + <listitem> + <para> + The maximum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmin</option>=<replaceable>lonmin</replaceable></term> + <listitem> + <para> + The minimum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmax</option>=<replaceable>lonmax</replaceable></term> + <listitem> + <para> + The maximum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=<replaceable>data-type</replaceable></term> + <listitem> + <para> + The type of data to select. + </para> + <para> + <replaceable>data-type</replaceable> can be selected from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>junctions</entry> + <entry>=</entry> + <entry>segment count at each junction.</entry> + </row> + <row> + <entry>super</entry> + <entry>=</entry> + <entry>super-node and super-segments.</entry> + </row> + <row> + <entry>waytype-*</entry> + <entry>=</entry> + <entry>segments of oneway, cyclebothways or roundabout type.</entry> + </row> + <row> + <entry>highway-*</entry> + <entry>=</entry> + <entry>segments of the specified highway type.</entry> + </row> + <row> + <entry>transport-*</entry> + <entry>=</entry> + <entry>segments allowing the specified transport type.</entry> + </row> + <row> + <entry>barrier-*</entry> + <entry>=</entry> + <entry>nodes disallowing the specified transport type.</entry> + </row> + <row> + <entry>turns</entry> + <entry>=</entry> + <entry>turn restrictions.</entry> + </row> + <row> + <entry>speed</entry> + <entry>=</entry> + <entry>speed limits.</entry> + </row> + <row> + <entry>weight</entry> + <entry>=</entry> + <entry>weight limits.</entry> + </row> + <row> + <entry>height</entry> + <entry>=</entry> + <entry>height limits.</entry> + </row> + <row> + <entry>width</entry> + <entry>=</entry> + <entry>width limits.</entry> + </row> + <row> + <entry>length</entry> + <entry>=</entry> + <entry>length limits.</entry> + </row> + <row> + <entry>property-*</entry> + <entry>=</entry> + <entry>segments with the specified property.</entry> + </row> + <row> + <entry>errorlogs</entry> + <entry>=</entry> + <entry>errors logged during parsing.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump</option></term> + <listitem> + <para> + Dump selected contents of the database. + </para> + <variablelist> + + <varlistentry> + <term><option>--node</option>=<replaceable>node</replaceable></term> + <listitem> + <para> + The node with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--segment</option>=<replaceable>segment</replaceable></term> + <listitem> + <para> + The segment with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--way</option>=<replaceable>way</replaceable></term> + <listitem> + <para> + The way with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--turn-relation</option>=<replaceable>rel</replaceable></term> + <listitem> + <para> + The turn relation with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--errorlog</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The error log with the selected index. + </para> + <para> + Use 'all' instead of a number to get all of them. + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump-osm</option></term> + <listitem> + <para> + Dump all or part of the database as an XML file. + </para> + <variablelist> + + <varlistentry> + <term><option>--no-super</option></term> + <listitem> + <para> + Exclude the super-segments. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmin</option>=<replaceable>latmin</replaceable></term> + <listitem> + <para> + The minimum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmax</option>=<replaceable>latmax</replaceable></term> + <listitem> + <para> + The maximum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmin</option>=<replaceable>lonmin</replaceable></term> + <listitem> + <para> + The minimum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmax</option>=<replaceable>lonmax</replaceable></term> + <listitem> + <para> + The maximum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump-visualiser</option></term> + <listitem> + <para> + Dump selected contents of the database in HTML. + </para> + <variablelist> + + <varlistentry> + <term><option>--data</option>=node<node></term> + <listitem> + <para> + The node with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=segment<segment></term> + <listitem> + <para> + The segment with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=turn-relation<rel></term> + <listitem> + <para> + The turn relation with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=errorlog<number></term> + <listitem> + <para> + The error log with the selected index. + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> diff --git a/debian/man/filedumper.1.xml b/debian/man/filedumper.1.xml new file mode 100644 index 0000000..8394a66 --- /dev/null +++ b/debian/man/filedumper.1.xml @@ -0,0 +1,407 @@ +<?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='filedumper'> + + <refmeta> + <refentrytitle>filedumper</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>filedumper</refname> + <refpurpose>dump routino database contents</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>filedumper</command> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--statistics</option></arg> + <arg choice='opt'><option>--visualiser</option> + <arg choice='plain'><option>--latmin=<replaceable>latmin</replaceable></option></arg> + <arg choice='plain'><option>--latmax=<replaceable>latmax</replaceable></option></arg> + <arg choice='plain'><option>--lonmin=<replaceable>lonmin</replaceable></option></arg> + <arg choice='plain'><option>--lonmax=<replaceable>lonmax</replaceable></option></arg> + <arg choice='plain'><option>--data=<replaceable>data-type</replaceable></option></arg> + </arg> + <arg choice='opt'><option>--dump</option> + <arg choice='opt'><option>--node=<replaceable>node</replaceable></option> ...</arg> + <arg choice='opt'><option>--segment=<replaceable>segment</replaceable></option> ...</arg> + <arg choice='opt'><option>--way=<replaceable>way</replaceable></option> ...</arg> + <arg choice='opt'><option>--turn-relation=<replaceable>rel</replaceable></option> ...</arg> + <arg choice='opt'><option>--errorlog=<replaceable>number</replaceable></option> ...</arg> + </arg> + <arg choice='opt'><option>--dump-osm</option> + <arg choice='opt'><option>--no-super</option></arg> + <arg choice='opt'><option>--latmin=<replaceable>latmin</replaceable></option> + <arg choice='plain'><option>--latmax=<replaceable>latmax</replaceable></option></arg> + <arg choice='plain'><option>--lonmin=<replaceable>lonmin</replaceable></option></arg> + <arg choice='plain'><option>--lonmax=<replaceable>lonmax</replaceable></option></arg> + </arg> + </arg> + <arg choice='opt'><option>--dump-visualiser</option> + <arg choice='opt'><option>--data=node<node></option></arg> + <arg choice='opt'><option>--data=segment<segment></option></arg> + <arg choice='opt'><option>--data=turn-relation<rel></option></arg> + <arg choice='opt'><option>--data=errorlog<number></option></arg> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>filedumper</command> is used to extract statistics from the + <command>routino</command> database, extract particular information for + visualisation purposes or for dumping the database contents. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + The directory containing the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + The filename prefix for the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--statistics</option></term> + <listitem> + <para> + Print statistics about the routing database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--visualiser</option></term> + <listitem> + <para> + Extract selected data from the routing database: + </para> + <variablelist> + + <varlistentry> + <term><option>--latmin</option>=<replaceable>latmin</replaceable></term> + <listitem> + <para> + The minimum latitude (degrees N) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmax</option>=<replaceable>latmax</replaceable></term> + <listitem> + <para> + The maximum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmin</option>=<replaceable>lonmin</replaceable></term> + <listitem> + <para> + The minimum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmax</option>=<replaceable>lonmax</replaceable></term> + <listitem> + <para> + The maximum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=<replaceable>data-type</replaceable></term> + <listitem> + <para> + The type of data to select. + </para> + <para> + <replaceable>data-type</replaceable> can be selected from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>junctions</entry> + <entry>=</entry> + <entry>segment count at each junction.</entry> + </row> + <row> + <entry>super</entry> + <entry>=</entry> + <entry>super-node and super-segments.</entry> + </row> + <row> + <entry>waytype-*</entry> + <entry>=</entry> + <entry>segments of oneway, cyclebothways or roundabout type.</entry> + </row> + <row> + <entry>highway-*</entry> + <entry>=</entry> + <entry>segments of the specified highway type.</entry> + </row> + <row> + <entry>transport-*</entry> + <entry>=</entry> + <entry>segments allowing the specified transport type.</entry> + </row> + <row> + <entry>barrier-*</entry> + <entry>=</entry> + <entry>nodes disallowing the specified transport type.</entry> + </row> + <row> + <entry>turns</entry> + <entry>=</entry> + <entry>turn restrictions.</entry> + </row> + <row> + <entry>speed</entry> + <entry>=</entry> + <entry>speed limits.</entry> + </row> + <row> + <entry>weight</entry> + <entry>=</entry> + <entry>weight limits.</entry> + </row> + <row> + <entry>height</entry> + <entry>=</entry> + <entry>height limits.</entry> + </row> + <row> + <entry>width</entry> + <entry>=</entry> + <entry>width limits.</entry> + </row> + <row> + <entry>length</entry> + <entry>=</entry> + <entry>length limits.</entry> + </row> + <row> + <entry>property-*</entry> + <entry>=</entry> + <entry>segments with the specified property.</entry> + </row> + <row> + <entry>errorlogs</entry> + <entry>=</entry> + <entry>errors logged during parsing.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump</option></term> + <listitem> + <para> + Dump selected contents of the database. + </para> + <variablelist> + + <varlistentry> + <term><option>--node</option>=<replaceable>node</replaceable></term> + <listitem> + <para> + The node with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--segment</option>=<replaceable>segment</replaceable></term> + <listitem> + <para> + The segment with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--way</option>=<replaceable>way</replaceable></term> + <listitem> + <para> + The way with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--turn-relation</option>=<replaceable>rel</replaceable></term> + <listitem> + <para> + The turn relation with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--errorlog</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The error log with the selected index. + </para> + <para> + Use 'all' instead of a number to get all of them. + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump-osm</option></term> + <listitem> + <para> + Dump all or part of the database as an XML file. + </para> + <variablelist> + + <varlistentry> + <term><option>--no-super</option></term> + <listitem> + <para> + Exclude the super-segments. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmin</option>=<replaceable>latmin</replaceable></term> + <listitem> + <para> + The minimum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--latmax</option>=<replaceable>latmax</replaceable></term> + <listitem> + <para> + The maximum latitude (degrees N). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmin</option>=<replaceable>lonmin</replaceable></term> + <listitem> + <para> + The minimum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lonmax</option>=<replaceable>lonmax</replaceable></term> + <listitem> + <para> + The maximum longitude (degrees E). + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump-visualiser</option></term> + <listitem> + <para> + Dump selected contents of the database in HTML. + </para> + <variablelist> + + <varlistentry> + <term><option>--data</option>=node<node></term> + <listitem> + <para> + The node with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=segment<segment></term> + <listitem> + <para> + The segment with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=turn-relation<rel></term> + <listitem> + <para> + The turn relation with the selected index. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--data</option>=errorlog<number></term> + <listitem> + <para> + The error log with the selected index. + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> diff --git a/debian/man/filedumperx.1.xml b/debian/man/filedumperx.1.xml new file mode 100644 index 0000000..1ccb0a6 --- /dev/null +++ b/debian/man/filedumperx.1.xml @@ -0,0 +1,155 @@ +<?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='filedumperx'> + + <refmeta> + <refentrytitle>filedumperx</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>filedumperx</refname> + <refpurpose>dump contents of planetsplitter intermediate data</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>filedumperx</command> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--dump</option> + <arg choice='opt'><option>--nodes</option></arg> + <arg choice='opt'><option>--ways</option></arg> + <arg choice='opt'><option>--route-relations</option></arg> + <arg choice='opt'><option>--turn-relations</option></arg> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>filedumperx</command> is a modified version of + <citerefentry> + <refentrytitle>filedumper</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry>, + that will dump out the contents of the intermediate data that is saved by + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry>, + after processing using the <option>--keep</option> or + <option>--changes</option> option. + This is intended for test purposes only and gives no useful information + about the <command>routino</command> routing database. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Sets the directory name in which to read the local database. + Defaults to the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Sets the filename prefix for the files in the local database. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dump</option></term> + <listitem> + <para> + Dumps the complete set of data in the intermediate files that are + written by + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry>, + using the <option>--keep</option> or <option>--changes</option> + options. + </para> + <variablelist> + + <varlistentry> + <term><option>--nodes</option></term> + <listitem> + <para> + Dumps the node data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--ways</option></term> + <listitem> + <para> + Dumps the way data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--route-relations</option></term> + <listitem> + <para> + Dumps the route relation data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--turn-relations</option></term> + <listitem> + <para> + Dumps the turn relation data. + </para> + </listitem> + </varlistentry> + + </variablelist> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='see-also'> + <title>SEE ALSO</title> + + <citerefentry> + <refentrytitle>filedumper</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry>, + + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry> + </refsect1> + +</refentry> diff --git a/debian/man/planetsplitter-slim.1.xml b/debian/man/planetsplitter-slim.1.xml new file mode 100644 index 0000000..5bfdf1d --- /dev/null +++ b/debian/man/planetsplitter-slim.1.xml @@ -0,0 +1,346 @@ +<?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='planetsplitter-slim'> + + <refmeta> + <refentrytitle>planetsplitter-slim</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>planetsplitter-slim</refname> + <refpurpose>split OSM XML data into routino database</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>planetsplitter-slim</command> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--sort-ram-size=<replaceable>size</replaceable></option></arg> + <arg choice='opt'><option>--sort-threads=<replaceable>number</replaceable></option></arg> + <arg choice='opt'><option>--tmpdir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--tagging=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--loggable</option></arg> + <arg choice='opt'><option>--logtime</option></arg> + <arg choice='opt'><option>--logmemory</option></arg> + <arg choice='opt'><option>--errorlog<arg choice='opt'>=<replaceable>name</replaceable></arg></option></arg> + <group> + <arg choice='opt'><option>--parse-only</option></arg> + <arg choice='opt'><option>--process-only</option></arg> + </group> + <arg choice='opt'><option>--append</option></arg> + <arg choice='opt'><option>--keep</option></arg> + <arg choice='opt'><option>--changes</option></arg> + <arg choice='opt'><option>--max-iterations=<replaceable>number</replaceable></option></arg> + <arg choice='opt'><option>--prune-none</option></arg> + <arg choice='opt'><option>--prune-isolated=<replaceable>len</replaceable></option></arg> + <arg choice='opt'><option>--prune-short=<replaceable>len</replaceable></option></arg> + <arg choice='opt'><option>--prune-straight=<replaceable>len</replaceable></option></arg> + <group> + <arg choice='opt'><replaceable>filename.osm</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.osc</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.pbf</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.o5m</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.o5c</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).bz2</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).gz</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).xz</replaceable> ...</arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>planetsplitter-slim</command> reads in the OSM format XML file and + splits it up to create the <command>routino</command> database that is + for routing. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Sets the directory name in which to save the results. + Defaults to the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Sets the filename prefix for the files that are created. + Defaults to no prefix. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--sort-ram-size</option>=<replaceable>size</replaceable></term> + <listitem> + <para> + Specifies the amount of RAM (in MB) to use for sorting the data. + If not specified then 64 MB will be used in slim mode or 256 MB + otherwise. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--sort-threads</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The number of threads to use for data sorting (the sorting memory + is shared between the threads \- too many threads and not enough + memory will reduce the performance). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--tmpdir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Specifies the name of the directory to store the temporary disk + files. + If not specified then it defaults to either the value of the + <option>--dir</option> option or the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--tagging</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of tagging rules in XML + format for the parsing the input files. + If the file doesn't exist then + <replaceable>dirname</replaceable>, + <replaceable>prefix</replaceable> and "profiles.xml" will be + combined and used, if that doesn't exist then the file + <filename>/usr/share/routino/profiles.xml</filename> + will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loggable</option></term> + <listitem> + <para> + Print progress messages that are suitable for logging to a file; + normally an incrementing counter is printed which is more suitable + for real-time display than logging. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logtime</option>></term> + <listitem> + <para> + Print the elapsed time for each processing step + (minutes, seconds and milliseconds). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logmemory</option></term> + <listitem> + <para> + Print the maximum allocated and mapped memory for each processing + step (MBytes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--errorlog[=<replaceable>name</replaceable>]</option></term> + <listitem> + <para> + Log OSM parsing and processing errors to + <filename>error.log</filename> or the specified file name + (the <option>--dir</option> and <option>--prefix</option> options + are applied). + If the <option>--append</option> option is used then the existing + log file will be appended, otherwise a new one will be created. + If the <option>--keep</option> option is also used a geographically + searchable database of error logs is created for use in the + visualiser. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--parse-only</option></term> + <listitem> + <para> + Parse the input files and store the data in intermediate files but + don't process the data into a routing database. + This option must be used with the <option>--append</option> option + for all except the first file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--process-only</option></term> + <listitem> + <para> + Don't read in any files but process the existing intermediate files + created by using the <option>--parse-only</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--append</option></term> + <listitem> + <para> + Parse the input file and append the result to the existing + intermediate files; the appended file can be either an OSM + file or an OSC change file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--keep</option></term> + <listitem> + <para> + Store a set of intermediate files after parsing the OSM files, + sorting and removing duplicates; this allows appending an OSC + file and re-processing later. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--changes</option></term> + <listitem> + <para> + This option indicates that the data being processed contains one or + more OSC (OSM changes) files, they must be applied in time sequence + if more than one is used. + This option implies <option>--append</option> when parsing data + files and <option>--keep</option> when processing data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--max-iterations</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The maximum number of iterations to use when generating super-nodes + and super-segments. + Defaults to 5 which is normally enough. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-none</option></term> + <listitem> + <para> + Disable the prune options below, they can be re-enabled by adding + them to the command line after this option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-isolated</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove the access permissions for a transport type from small + disconnected groups of segments and remove the segments if they + end up with no access permission (defaults to removing groups + under 500m). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-short</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove short segments (defaults to removing segments up to a + maximum length of 5m). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-straight=</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove nodes in almost straight highways (defaults to removing + nodes up to 3m offset from a straight line). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>filename.osm</filename></term> + <term><filename>filename.osc</filename></term> + <term><filename>filename.pbf</filename></term> + <term><filename>filename.o5m</filename></term> + <term><filename>filename.o5c</filename></term> + <listitem> + <para> + Specifies the filename(s) to read data from. + Filenames ending '.pbf' will be read as PBF, filenames ending in + '.o5m' or '.o5c' will be read as O5M/O5C, otherwise as XML. + Filenames ending '.bz2' will be bzip2 uncompressed + (if bzip2 support compiled in). + Filenames ending '.gz' will be gzip uncompressed + (if gzip support compiled in). + Filenames ending '.xz' will be xz uncompressed + (if xz support compiled in). + </para> + <para> + Note: In version 2.5 of Routino the ability to read data from the + standard input has been removed. + This is because there is now the ability to read compressed files + (bzip2, gzip, xz) and PBF files directly. + Also using standard input the file type cannot be auto-detected + from the filename. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='see-also'> + <title>SEE ALSO</title> + + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry> + </refsect1> + +</refentry> diff --git a/debian/man/planetsplitter.1.xml b/debian/man/planetsplitter.1.xml new file mode 100644 index 0000000..fa81569 --- /dev/null +++ b/debian/man/planetsplitter.1.xml @@ -0,0 +1,405 @@ +<?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='planetsplitter'> + + <refmeta> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>planetsplitter</refname> + <refpurpose>split OSM XML data into routino database</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>planetsplitter</command> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--sort-ram-size=<replaceable>size</replaceable></option></arg> + <arg choice='opt'><option>--sort-threads=<replaceable>number</replaceable></option></arg> + <arg choice='opt'><option>--tmpdir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--tagging=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--loggable</option></arg> + <arg choice='opt'><option>--logtime</option></arg> + <arg choice='opt'><option>--logmemory</option></arg> + <arg choice='opt'><option>--errorlog<arg choice='opt'>=<replaceable>name</replaceable></arg></option></arg> + <group> + <arg choice='opt'><option>--parse-only</option></arg> + <arg choice='opt'><option>--process-only</option></arg> + </group> + <arg choice='opt'><option>--append</option></arg> + <arg choice='opt'><option>--keep</option></arg> + <arg choice='opt'><option>--changes</option></arg> + <arg choice='opt'><option>--max-iterations=<replaceable>number</replaceable></option></arg> + <arg choice='opt'><option>--prune-none</option></arg> + <arg choice='opt'><option>--prune-isolated=<replaceable>len</replaceable></option></arg> + <arg choice='opt'><option>--prune-short=<replaceable>len</replaceable></option></arg> + <arg choice='opt'><option>--prune-straight=<replaceable>len</replaceable></option></arg> + <group> + <arg choice='opt'><replaceable>filename.osm</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.osc</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.pbf</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.o5m</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.o5c</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).bz2</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).gz</replaceable> ...</arg> + <arg choice='opt'><replaceable>filename.(o5m|osc|os5m|o5c).xz</replaceable> ...</arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>planetsplitter</command> reads in the OSM format XML file and + splits it up to create the <command>routino</command> database that is + for routing. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Sets the directory name in which to save the results. + Defaults to the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Sets the filename prefix for the files that are created. + Defaults to no prefix. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--sort-ram-size</option>=<replaceable>size</replaceable></term> + <listitem> + <para> + Specifies the amount of RAM (in MB) to use for sorting the data. + If not specified then 64 MB will be used in slim mode or 256 MB + otherwise. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--sort-threads</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The number of threads to use for data sorting (the sorting memory + is shared between the threads \- too many threads and not enough + memory will reduce the performance). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--tmpdir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Specifies the name of the directory to store the temporary disk + files. + If not specified then it defaults to either the value of the + <option>--dir</option> option or the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--tagging</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of tagging rules in XML + format for the parsing the input files. + If the file doesn't exist then + <replaceable>dirname</replaceable>, + <replaceable>prefix</replaceable> and "profiles.xml" will be + combined and used, if that doesn't exist then the file + <filename>/usr/share/routino/profiles.xml</filename> + will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loggable</option></term> + <listitem> + <para> + Print progress messages that are suitable for logging to a file; + normally an incrementing counter is printed which is more suitable + for real-time display than logging. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logtime</option>></term> + <listitem> + <para> + Print the elapsed time for each processing step + (minutes, seconds and milliseconds). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logmemory</option></term> + <listitem> + <para> + Print the maximum allocated and mapped memory for each processing + step (MBytes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--errorlog[=<replaceable>name</replaceable>]</option></term> + <listitem> + <para> + Log OSM parsing and processing errors to + <filename>error.log</filename> or the specified file name + (the <option>--dir</option> and <option>--prefix</option> options + are applied). + If the <option>--append</option> option is used then the existing + log file will be appended, otherwise a new one will be created. + If the <option>--keep</option> option is also used a geographically + searchable database of error logs is created for use in the + visualiser. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--parse-only</option></term> + <listitem> + <para> + Parse the input files and store the data in intermediate files but + don't process the data into a routing database. + This option must be used with the <option>--append</option> option + for all except the first file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--process-only</option></term> + <listitem> + <para> + Don't read in any files but process the existing intermediate files + created by using the <option>--parse-only</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--append</option></term> + <listitem> + <para> + Parse the input file and append the result to the existing + intermediate files; the appended file can be either an OSM + file or an OSC change file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--keep</option></term> + <listitem> + <para> + Store a set of intermediate files after parsing the OSM files, + sorting and removing duplicates; this allows appending an OSC + file and re-processing later. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--changes</option></term> + <listitem> + <para> + This option indicates that the data being processed contains one or + more OSC (OSM changes) files, they must be applied in time sequence + if more than one is used. + This option implies <option>--append</option> when parsing data + files and <option>--keep</option> when processing data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--max-iterations</option>=<replaceable>number</replaceable></term> + <listitem> + <para> + The maximum number of iterations to use when generating super-nodes + and super-segments. + Defaults to 5 which is normally enough. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-none</option></term> + <listitem> + <para> + Disable the prune options below, they can be re-enabled by adding + them to the command line after this option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-isolated</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove the access permissions for a transport type from small + disconnected groups of segments and remove the segments if they + end up with no access permission (defaults to removing groups + under 500m). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-short</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove short segments (defaults to removing segments up to a + maximum length of 5m). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prune-straight=</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Remove nodes in almost straight highways (defaults to removing + nodes up to 3m offset from a straight line). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>filename.osm</filename></term> + <term><filename>filename.osc</filename></term> + <term><filename>filename.pbf</filename></term> + <term><filename>filename.o5m</filename></term> + <term><filename>filename.o5c</filename></term> + <listitem> + <para> + Specifies the filename(s) to read data from. + Filenames ending '.pbf' will be read as PBF, filenames ending in + '.o5m' or '.o5c' will be read as O5M/O5C, otherwise as XML. + Filenames ending '.bz2' will be bzip2 uncompressed + (if bzip2 support compiled in). + Filenames ending '.gz' will be gzip uncompressed + (if gzip support compiled in). + Filenames ending '.xz' will be xz uncompressed + (if xz support compiled in). + </para> + <para> + Note: In version 2.5 of Routino the ability to read data from the + standard input has been removed. + This is because there is now the ability to read compressed files + (bzip2, gzip, xz) and PBF files directly. + Also using standard input the file type cannot be auto-detected + from the filename. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + + <example> + <para> + Example usage 1: + </para> + <screen> +<command>planetsplitter</command> <option>--dir</option>=<filename>data</filename> <option>--prefix</option>=gb <filename>great_britain.osm</filename> + </screen> + <para> + This will generate the output files + <filename>data/gb-nodes.mem</filename>, + <filename>data/gb-segments.mem</filename> and + <filename>data/gb-ways.mem</filename>. + Multiple filenames can be specified on the command line and they will + all be read in, combined and processed together. + </para> + </example> + + <example> + <para> + Example usage 2: + </para> + <screen> +<command>planetsplitter</command> <option>--dir</option>=data <option>--prefix</option>=gb <option>--parse-only</option> <filename>great_britain_part1.osm</filename> +<command>planetsplitter</command> <option>--dir</option>=data <option>--prefix</option>=gb <option>--parse-only</option> <option>--append</option> <filename>great_britain_part2.osm</filename> +<command>planetsplitter</command> <option>--dir</option>=data <option>--prefix</option>=gb <option>--parse-only</option> <option>--append</option> ... +<command>planetsplitter</command> <option>--dir</option>=data <option>--prefix</option>=gb <option>--process-only</option> + </screen> + <para> + This will generate the same output files as the first example but + parsing the input files is performed separately from the data + processing. + The first file read in must not use the <option>--append</option> + option but the later ones must. + </para> + </example> + + <example> + <para> + Example usage 3: + </para> + <screen> +<command>planetsplitter</command> <option>--dir</option>=<filename>data</filename> <option>--prefix</option>=gb <option>--keep</option> <filename>great_britain.osm</filename> + +<command>planetsplitter</command> <option>--dir</option>=<filename>data</filename> <option>--prefix</option>=gb <option>--changes</option> <filename>great_britain.osc</filename> + </screen> + <para> + This will generate the same output files as the first example. + The first command will process the complete file and keep some + intermediate data for later. + The second command will apply a set of changes to the stored + intermediate data and keep the updated intermediate files for + repeating this step later with more change data. + </para> + <para> + The parsing and processing can be split into multiple commands + as it was in example 2 with the <option>--keep</option> option + used with <option>--process-only</option> for the initial OSM + file(s) and the <option>--changes</option> option used with + <option>--parse-only</option> or <option>--process-only</option> + for every OSC file. + </para> + </example> + + </refsect1> + +</refentry> diff --git a/debian/man/routino-router-slim.1.xml b/debian/man/routino-router-slim.1.xml new file mode 100644 index 0000000..a7042d5 --- /dev/null +++ b/debian/man/routino-router-slim.1.xml @@ -0,0 +1,696 @@ +<?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='routino-router-slim'> + + <refmeta> + <refentrytitle>routino-router-slim</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>routino-router-slim</refname> + <refpurpose>calculate routes using the routino database</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>routino-router-slim</command> + <group> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--help-profile-xml</option></arg> + <arg choice='opt'><option>--help-profile-json</option></arg> + <arg choice='opt'><option>--help-profile-perl</option></arg> + </group> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--profiles=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--translations=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--exact-nodes-only</option></arg> + <arg choice='opt'><option>--quiet</option></arg> + <arg choice='opt'><option>--loggable</option></arg> + <arg choice='opt'><option>--logtime</option></arg> + <arg choice='opt'><option>--logmemory</option></arg> + <arg choice='opt'><option>--output-html</option></arg> + <arg choice='opt'><option>--output-gpx-track</option></arg> + <arg choice='opt'><option>--output-text-all</option></arg> + <arg choice='opt'><option>--output-none</option></arg> + <arg choice='opt'><option>--output-stdout</option></arg> + <arg choice='opt'><option>--profile=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--transport=<replaceable>transport</replaceable></option></arg> + <group> + <arg choice='opt'><option>--shortest</option></arg> + <arg choice='opt'><option>--quickest</option></arg> + </group> + <arg choice='plain'><option>--lon1=<replaceable>longitude</replaceable></option> <option>--lat1=<replaceable>latitude</replaceable></option></arg> + <arg choice='plain'><option>--lon2=<replaceable>longitude</replaceable></option> <option>--lat2=<replaceable>latitude</replaceable></option></arg> + <arg choice='opt'>... <option>--lon99=<replaceable>longitude</replaceable></option> <option>--lat99=<replaceable>latitude</replaceable></option></arg> + <arg choice='opt'><option>--reverse</option></arg> + <arg choice='opt'><option>--loop</option></arg> + <arg choice='opt'><option>--heading=<replaceable>bearing</replaceable></option></arg> + <arg choice='opt'><option>--highway-<highway>=<replaceable>preference</replaceable></option> ...</arg> + <arg choice='opt'><option>--speed-<highway>=<replaceable>speed</replaceable></option> ...</arg> + <arg choice='opt'><option>--property-<property>=<replaceable>preference</replaceable></option> ...</arg> + <arg choice='opt'><option>--oneway=<replaceable>0|1</replaceable></option></arg> + <arg choice='opt'><option>--turns=<replaceable>0|1</replaceable></option></arg> + <arg choice='opt'><option>--weight=<replaceable>weight</replaceable></option></arg> + <arg choice='opt'><option>--height=<replaceable>height</replaceable></option></arg> + <arg choice='opt'><option>--width=<replaceable>width</replaceable></option></arg> + <arg choice='opt'><option>--length=<replaceable>length</replaceable></option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>routino-router-slim</command> performs the calculation of the + optimum routes using the database generated by the + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry> + program. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints out the help information. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile</option></term> + <listitem> + <para> + Prints out the selected transport profile + (type, speed limits, highway preferences etc.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-xml</option></term> + <listitem> + <para> + Prints out all the loaded profiles as an XML file in the same + format that can be loaded in. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-json</option></term> + <listitem> + <para> + Prints out all the loaded profiles in JavaScript Object Notation + (JSON) format for use in the interactive webpage. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-perl</option></term> + <listitem> + <para> + Prints out all the loaded profiles as a Perl object for use in + the router CGI. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Sets the directory name in which to read the local database. + Defaults to the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Sets the filename prefix for the files in the local database. + Defaults to no prefix. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--profiles</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of routing profiles in XML + format. + If the file doesn't exist then <option>--dirname</option>, + <option>--prefix</option> and "profiles.xml" will be combined and + used, if that doesn't exist then the file + <filename>/usr/share/routino/profiles.xml</filename> + (or custom installation location) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--translations</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of translations in XML + format for the output files. + If the file doesn't exist then <option>--dirname</option>, + <option>--prefix</option> and "translations.xml" will be combined + and used, if that doesn't exist then the file + <filename>/usr/share/routino/translations.xml</filename> + (or custom installation location) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--exact-nodes-only</option></term> + <listitem> + <para> + When processing the specified latitude and longitude points only + select the nearest node instead of finding the nearest point + within a segment (quicker but less accurate unless the points are + already near nodes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--quiet</option></term> + <listitem> + <para> + Don't generate any screen output while running + (useful for running in a script). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loggable</option></term> + <listitem> + <para> + Print progress messages that are suitable for logging to a file; + normally an incrementing counter is printed which is more suitable + for real-time display than logging. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logtime</option></term> + <listitem> + <para> + Print the elapsed time for each processing step + (minutes, seconds and milliseconds). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logmemory</option></term> + <listitem> + <para> + Print the maximum allocated and mapped memory for each processing + step (MBytes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--language</option>=<replaceable>lang</replaceable></term> + <listitem> + <para> + Select the language specified from the file of translations. + If this option is not given and the file exists then the first + language in the file will be used. + If this option is not given and no file exists the compiled-in + default language (English) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-html</option></term> + <term><option>--output-gpx-track</option></term> + <term><option>--output-gpx-route</option></term> + <term><option>--output-text</option></term> + <term><option>--output-text-all</option></term> + <listitem> + <para> + Generate the selected output file formats (HTML, GPX track file, + GPX route file, plain text route and/or plain text with all nodes). + If no output is specified then all are generated, specifying any + automatically disables those not specified. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-none</option></term> + <listitem> + <para> + Do not generate any output or read in any translations files. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-stdout</option></term> + <listitem> + <para> + Write to stdout instead of a file (requires exactly one output + format option, implies <option>--quiet</option>). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--profile</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Specifies the name of the profile to use. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--transport</option>=<replaceable>transport</replaceable></term> + <listitem> + <para> + Select the type of transport to use, <replaceable>transport</replaceable> can be set to: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>foot</entry> + <entry>=</entry> + <entry>Foot</entry> + </row> + <row> + <entry>horse</entry> + <entry>=</entry> + <entry>Horse</entry> + </row> + <row> + <entry>wheelchair</entry> + <entry>=</entry> + <entry>Wheelchair</entry> + </row> + <row> + <entry>bicycle</entry> + <entry>=</entry> + <entry>Bicycle</entry> + </row> + <row> + <entry>moped</entry> + <entry>=</entry> + <entry>Moped (Small motorcycle, limited speed)</entry> + </row> + <row> + <entry>motorcycle</entry> + <entry>=</entry> + <entry>Motorcycle</entry> + </row> + <row> + <entry>motorcar</entry> + <entry>=</entry> + <entry>Motorcar</entry> + </row> + <row> + <entry>goods</entry> + <entry>=</entry> + <entry>Goods (Small lorry, van)</entry> + </row> + <row> + <entry>hgv</entry> + <entry>=</entry> + <entry>HGV (Heavy Goods Vehicle \- large lorry)</entry> + </row> + <row> + <entry>psv</entry> + <entry>=</entry> + <entry>PSV (Public Service Vehicle \- bus, coach)</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Defaults to 'motorcar', this option also selects the default + profile information if the <option>--profile</option> option is + not given and a profile matching the transport name is found. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--shortest</option></term> + <listitem> + <para> + Find the shortest route between the waypoints. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--quickest</option></term> + <listitem> + <para> + Find the quickest route between the waypoints. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lon1</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat1</option>=<replaceable>latitude</replaceable></term> + <term><option>--lon2</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat2</option>=<replaceable>latitude</replaceable></term> + <term>... <option>--lon99</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat99</option>=<replaceable>latitude</replaceable></term> + <listitem> + <para> + The location of the waypoints that make up the start, middle and + end points of the route. Up to 99 waypoints can be specified and + the route will pass through each of the specified ones in sequence. + The algorithm will use the closest node or point within a segment + that allows the specified traffic type. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--reverse</option></term> + <listitem> + <para> + Find a route between the waypoints in reverse order. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loop</option></term> + <listitem> + <para> + Find a route that returns to the first waypoint after the last one. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--heading</option>=<replaceable>bearing</replaceable></term> + <listitem> + <para> + Specifies the initial direction of travel at the start of the + route (from the lowest numbered waypoint) as a compass bearing + from 0 to 360 degrees. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--highway-<highway></option>=<replaceable>preference</replaceable></term> + <listitem> + <para> + Selects the percentage preference for using each particular type + of highway. + The value of <replaceable>highway</replaceable> can be selected + from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>motorway</entry> + <entry>=</entry> + <entry>Motorway</entry> + </row> + <row> + <entry>trunk</entry> + <entry>=</entry> + <entry>Trunk</entry> + </row> + <row> + <entry>primary</entry> + <entry>=</entry> + <entry>Primary</entry> + </row> + <row> + <entry>secondary</entry> + <entry>=</entry> + <entry>Secondary</entry> + </row> + <row> + <entry>tertiary</entry> + <entry>=</entry> + <entry>Tertiary</entry> + </row> + <row> + <entry>unclassified</entry> + <entry>=</entry> + <entry>Unclassified</entry> + </row> + <row> + <entry>residential</entry> + <entry>=</entry> + <entry>Residential</entry> + </row> + <row> + <entry>service</entry> + <entry>=</entry> + <entry>Service</entry> + </row> + <row> + <entry>track</entry> + <entry>=</entry> + <entry>Track</entry> + </row> + <row> + <entry>cycleway</entry> + <entry>=</entry> + <entry>Cycleway</entry> + </row> + <row> + <entry>path</entry> + <entry>=</entry> + <entry>Path</entry> + </row> + <row> + <entry>steps</entry> + <entry>=</entry> + <entry>Steps</entry> + </row> + <row> + <entry>ferry</entry> + <entry>=</entry> + <entry>Ferry</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--speed-<highway></option>=<replaceable>speed</replaceable></term> + <listitem> + <para> + Selects the speed limit in km/hour for each type of highway. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--property-<property></option>=<replaceable>preference</replaceable></term> + <listitem> + <para> + Selects the percentage preference for using each particular + highway property. + The value of <replaceable>property</replaceable> can be selected + from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>paved</entry> + <entry>=</entry> + <entry>Paved (suitable for normal wheels)</entry> + </row> + <row> + <entry>multilane</entry> + <entry>=</entry> + <entry>Multiple lanes</entry> + </row> + <row> + <entry>bridge</entry> + <entry>=</entry> + <entry>Bridge</entry> + </row> + <row> + <entry>tunnel</entry> + <entry>=</entry> + <entry>Tunnel</entry> + </row> + <row> + <entry>footroute</entry> + <entry>=</entry> + <entry>A route marked for foot travel</entry> + </row> + <row> + <entry>bicycleroute</entry> + <entry>=</entry> + <entry>A route marked for bicycle travel</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--oneway=</option>=<replaceable>0|1</replaceable></term> + <listitem> + <para> + Selects if the direction of oneway streets are to be obeyed + (useful to not obey them when walking). + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--turns=</option>=<replaceable>0|1</replaceable></term> + <listitem> + <para> + Selects if turn restrictions are to be obeyed (useful to not obey + them when walking). + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--weight</option>=<replaceable>weight</replaceable></term> + <listitem> + <para> + Specifies the weight of the mode of transport in tonnes; ensures + that the weight limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--height</option>=<replaceable>height</replaceable></term> + <listitem> + <para> + Specifies the height of the mode of transport in metres; ensures + that the height limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--width</option>=<replaceable>width</replaceable></term> + <listitem> + <para> + Specifies the width of the mode of transport in metres; ensures + that the width limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--length</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Specifies the length of the mode of transport in metres; ensures + that the length limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + </variablelist> + + <para> + The meaning of the <replaceable>preference</replaceable> parameter in + the command line options is slightly different for the highway + preferences and the property preferences. + For the highway preference consider the choice between two possible + highways between the start and finish when looking for the shortest + route. + If highway A has a preference of 100% and highway B has a preference of + 90% then highway A will be chosen even if it is up to 11% longer + (100/90 = 111%). + For the highway properties each highway either has a particular property + or not. + If the preference for the property is 60% then a highway with the + property has a preference of 77% (sqrt(60%)) and one without has a + preference of 63% (sqrt(100-60%)). + A highway with the property will be chosen even if it is up to 22% + longer than one without the property (77/63 = 122%). + The overall preference for each highway segment is the product of the + preference for the highway type and all of the preferences for the + highway properties. + </para> + + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + + <example> + <para> + Example usage (motorcycle journey, scenic route, not very fast): + </para> + <screen> +<command>routino-router-slim</command> <option>--dir</option>=<filename>data</filename> <option>--prefix</option>=gb <option>--transport</option>=motorcycle \ + <option>--highway-motorway</option>=0 <option>--highway-trunk</option>=0 \ + <option>--speed-primary</option>=80 <option>--speed-secondary</option>=80 \ + <option>--quickest</option> + </screen> + <para> + This will use the files + <filename>data/gb-nodes.mem</filename>, + <filename>data/gb-segments.mem</filename> and + <filename>data/gb-ways.mem</filename> to find the quickest route by + motorcycle not using motorways or trunk roads and not exceeding 80 + km/hr. + </para> + </example> + + </refsect1> + +</refentry> diff --git a/debian/man/routino-router.1.xml b/debian/man/routino-router.1.xml new file mode 100644 index 0000000..0aaa876 --- /dev/null +++ b/debian/man/routino-router.1.xml @@ -0,0 +1,696 @@ +<?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='routino-router'> + + <refmeta> + <refentrytitle>routino-router</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>routino-router</refname> + <refpurpose>calculate routes using the routino database</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>routino-router</command> + <group> + <arg choice='opt'><option>--help</option></arg> + <arg choice='opt'><option>--help-profile-xml</option></arg> + <arg choice='opt'><option>--help-profile-json</option></arg> + <arg choice='opt'><option>--help-profile-perl</option></arg> + </group> + <arg choice='opt'><option>--dir=<replaceable>dirname</replaceable></option></arg> + <arg choice='opt'><option>--prefix=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--profiles=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--translations=<replaceable>filename</replaceable></option></arg> + <arg choice='opt'><option>--exact-nodes-only</option></arg> + <arg choice='opt'><option>--quiet</option></arg> + <arg choice='opt'><option>--loggable</option></arg> + <arg choice='opt'><option>--logtime</option></arg> + <arg choice='opt'><option>--logmemory</option></arg> + <arg choice='opt'><option>--output-html</option></arg> + <arg choice='opt'><option>--output-gpx-track</option></arg> + <arg choice='opt'><option>--output-text-all</option></arg> + <arg choice='opt'><option>--output-none</option></arg> + <arg choice='opt'><option>--output-stdout</option></arg> + <arg choice='opt'><option>--profile=<replaceable>name</replaceable></option></arg> + <arg choice='opt'><option>--transport=<replaceable>transport</replaceable></option></arg> + <group> + <arg choice='opt'><option>--shortest</option></arg> + <arg choice='opt'><option>--quickest</option></arg> + </group> + <arg choice='plain'><option>--lon1=<replaceable>longitude</replaceable></option> <option>--lat1=<replaceable>latitude</replaceable></option></arg> + <arg choice='plain'><option>--lon2=<replaceable>longitude</replaceable></option> <option>--lat2=<replaceable>latitude</replaceable></option></arg> + <arg choice='opt'>... <option>--lon99=<replaceable>longitude</replaceable></option> <option>--lat99=<replaceable>latitude</replaceable></option></arg> + <arg choice='opt'><option>--reverse</option></arg> + <arg choice='opt'><option>--loop</option></arg> + <arg choice='opt'><option>--heading=<replaceable>bearing</replaceable></option></arg> + <arg choice='opt'><option>--highway-<highway>=<replaceable>preference</replaceable></option> ...</arg> + <arg choice='opt'><option>--speed-<highway>=<replaceable>speed</replaceable></option> ...</arg> + <arg choice='opt'><option>--property-<property>=<replaceable>preference</replaceable></option> ...</arg> + <arg choice='opt'><option>--oneway=<replaceable>0|1</replaceable></option></arg> + <arg choice='opt'><option>--turns=<replaceable>0|1</replaceable></option></arg> + <arg choice='opt'><option>--weight=<replaceable>weight</replaceable></option></arg> + <arg choice='opt'><option>--height=<replaceable>height</replaceable></option></arg> + <arg choice='opt'><option>--width=<replaceable>width</replaceable></option></arg> + <arg choice='opt'><option>--length=<replaceable>length</replaceable></option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>routino-router</command> performs the calculation of the + optimum routes using the database generated by the + <citerefentry> + <refentrytitle>planetsplitter</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry> + program. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Prints out the help information. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile</option></term> + <listitem> + <para> + Prints out the selected transport profile + (type, speed limits, highway preferences etc.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-xml</option></term> + <listitem> + <para> + Prints out all the loaded profiles as an XML file in the same + format that can be loaded in. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-json</option></term> + <listitem> + <para> + Prints out all the loaded profiles in JavaScript Object Notation + (JSON) format for use in the interactive webpage. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help-profile-perl</option></term> + <listitem> + <para> + Prints out all the loaded profiles as a Perl object for use in + the router CGI. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dir</option>=<replaceable>dirname</replaceable></term> + <listitem> + <para> + Sets the directory name in which to read the local database. + Defaults to the current directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prefix</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Sets the filename prefix for the files in the local database. + Defaults to no prefix. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--profiles</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of routing profiles in XML + format. + If the file doesn't exist then <option>--dirname</option>, + <option>--prefix</option> and "profiles.xml" will be combined and + used, if that doesn't exist then the file + <filename>/usr/share/routino/profiles.xml</filename> + (or custom installation location) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--translations</option>=<replaceable>filename</replaceable></term> + <listitem> + <para> + Sets the filename containing the list of translations in XML + format for the output files. + If the file doesn't exist then <option>--dirname</option>, + <option>--prefix</option> and "translations.xml" will be combined + and used, if that doesn't exist then the file + <filename>/usr/share/routino/translations.xml</filename> + (or custom installation location) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--exact-nodes-only</option></term> + <listitem> + <para> + When processing the specified latitude and longitude points only + select the nearest node instead of finding the nearest point + within a segment (quicker but less accurate unless the points are + already near nodes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--quiet</option></term> + <listitem> + <para> + Don't generate any screen output while running + (useful for running in a script). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loggable</option></term> + <listitem> + <para> + Print progress messages that are suitable for logging to a file; + normally an incrementing counter is printed which is more suitable + for real-time display than logging. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logtime</option></term> + <listitem> + <para> + Print the elapsed time for each processing step + (minutes, seconds and milliseconds). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--logmemory</option></term> + <listitem> + <para> + Print the maximum allocated and mapped memory for each processing + step (MBytes). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--language</option>=<replaceable>lang</replaceable></term> + <listitem> + <para> + Select the language specified from the file of translations. + If this option is not given and the file exists then the first + language in the file will be used. + If this option is not given and no file exists the compiled-in + default language (English) will be used. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-html</option></term> + <term><option>--output-gpx-track</option></term> + <term><option>--output-gpx-route</option></term> + <term><option>--output-text</option></term> + <term><option>--output-text-all</option></term> + <listitem> + <para> + Generate the selected output file formats (HTML, GPX track file, + GPX route file, plain text route and/or plain text with all nodes). + If no output is specified then all are generated, specifying any + automatically disables those not specified. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-none</option></term> + <listitem> + <para> + Do not generate any output or read in any translations files. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output-stdout</option></term> + <listitem> + <para> + Write to stdout instead of a file (requires exactly one output + format option, implies <option>--quiet</option>). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--profile</option>=<replaceable>name</replaceable></term> + <listitem> + <para> + Specifies the name of the profile to use. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--transport</option>=<replaceable>transport</replaceable></term> + <listitem> + <para> + Select the type of transport to use, <replaceable>transport</replaceable> can be set to: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>foot</entry> + <entry>=</entry> + <entry>Foot</entry> + </row> + <row> + <entry>horse</entry> + <entry>=</entry> + <entry>Horse</entry> + </row> + <row> + <entry>wheelchair</entry> + <entry>=</entry> + <entry>Wheelchair</entry> + </row> + <row> + <entry>bicycle</entry> + <entry>=</entry> + <entry>Bicycle</entry> + </row> + <row> + <entry>moped</entry> + <entry>=</entry> + <entry>Moped (Small motorcycle, limited speed)</entry> + </row> + <row> + <entry>motorcycle</entry> + <entry>=</entry> + <entry>Motorcycle</entry> + </row> + <row> + <entry>motorcar</entry> + <entry>=</entry> + <entry>Motorcar</entry> + </row> + <row> + <entry>goods</entry> + <entry>=</entry> + <entry>Goods (Small lorry, van)</entry> + </row> + <row> + <entry>hgv</entry> + <entry>=</entry> + <entry>HGV (Heavy Goods Vehicle \- large lorry)</entry> + </row> + <row> + <entry>psv</entry> + <entry>=</entry> + <entry>PSV (Public Service Vehicle \- bus, coach)</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Defaults to 'motorcar', this option also selects the default + profile information if the <option>--profile</option> option is + not given and a profile matching the transport name is found. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--shortest</option></term> + <listitem> + <para> + Find the shortest route between the waypoints. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--quickest</option></term> + <listitem> + <para> + Find the quickest route between the waypoints. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--lon1</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat1</option>=<replaceable>latitude</replaceable></term> + <term><option>--lon2</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat2</option>=<replaceable>latitude</replaceable></term> + <term>... <option>--lon99</option>=<replaceable>longitude</replaceable></term> + <term><option>--lat99</option>=<replaceable>latitude</replaceable></term> + <listitem> + <para> + The location of the waypoints that make up the start, middle and + end points of the route. Up to 99 waypoints can be specified and + the route will pass through each of the specified ones in sequence. + The algorithm will use the closest node or point within a segment + that allows the specified traffic type. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--reverse</option></term> + <listitem> + <para> + Find a route between the waypoints in reverse order. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--loop</option></term> + <listitem> + <para> + Find a route that returns to the first waypoint after the last one. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--heading</option>=<replaceable>bearing</replaceable></term> + <listitem> + <para> + Specifies the initial direction of travel at the start of the + route (from the lowest numbered waypoint) as a compass bearing + from 0 to 360 degrees. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--highway-<highway></option>=<replaceable>preference</replaceable></term> + <listitem> + <para> + Selects the percentage preference for using each particular type + of highway. + The value of <replaceable>highway</replaceable> can be selected + from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>motorway</entry> + <entry>=</entry> + <entry>Motorway</entry> + </row> + <row> + <entry>trunk</entry> + <entry>=</entry> + <entry>Trunk</entry> + </row> + <row> + <entry>primary</entry> + <entry>=</entry> + <entry>Primary</entry> + </row> + <row> + <entry>secondary</entry> + <entry>=</entry> + <entry>Secondary</entry> + </row> + <row> + <entry>tertiary</entry> + <entry>=</entry> + <entry>Tertiary</entry> + </row> + <row> + <entry>unclassified</entry> + <entry>=</entry> + <entry>Unclassified</entry> + </row> + <row> + <entry>residential</entry> + <entry>=</entry> + <entry>Residential</entry> + </row> + <row> + <entry>service</entry> + <entry>=</entry> + <entry>Service</entry> + </row> + <row> + <entry>track</entry> + <entry>=</entry> + <entry>Track</entry> + </row> + <row> + <entry>cycleway</entry> + <entry>=</entry> + <entry>Cycleway</entry> + </row> + <row> + <entry>path</entry> + <entry>=</entry> + <entry>Path</entry> + </row> + <row> + <entry>steps</entry> + <entry>=</entry> + <entry>Steps</entry> + </row> + <row> + <entry>ferry</entry> + <entry>=</entry> + <entry>Ferry</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--speed-<highway></option>=<replaceable>speed</replaceable></term> + <listitem> + <para> + Selects the speed limit in km/hour for each type of highway. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--property-<property></option>=<replaceable>preference</replaceable></term> + <listitem> + <para> + Selects the percentage preference for using each particular + highway property. + The value of <replaceable>property</replaceable> can be selected + from: + <informaltable frame='none' colsep='0' rowsep='0'> + <tgroup cols='3'> + <tbody> + <row> + <entry>paved</entry> + <entry>=</entry> + <entry>Paved (suitable for normal wheels)</entry> + </row> + <row> + <entry>multilane</entry> + <entry>=</entry> + <entry>Multiple lanes</entry> + </row> + <row> + <entry>bridge</entry> + <entry>=</entry> + <entry>Bridge</entry> + </row> + <row> + <entry>tunnel</entry> + <entry>=</entry> + <entry>Tunnel</entry> + </row> + <row> + <entry>footroute</entry> + <entry>=</entry> + <entry>A route marked for foot travel</entry> + </row> + <row> + <entry>bicycleroute</entry> + <entry>=</entry> + <entry>A route marked for bicycle travel</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--oneway=</option>=<replaceable>0|1</replaceable></term> + <listitem> + <para> + Selects if the direction of oneway streets are to be obeyed + (useful to not obey them when walking). + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--turns=</option>=<replaceable>0|1</replaceable></term> + <listitem> + <para> + Selects if turn restrictions are to be obeyed (useful to not obey + them when walking). + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--weight</option>=<replaceable>weight</replaceable></term> + <listitem> + <para> + Specifies the weight of the mode of transport in tonnes; ensures + that the weight limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--height</option>=<replaceable>height</replaceable></term> + <listitem> + <para> + Specifies the height of the mode of transport in metres; ensures + that the height limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--width</option>=<replaceable>width</replaceable></term> + <listitem> + <para> + Specifies the width of the mode of transport in metres; ensures + that the width limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--length</option>=<replaceable>length</replaceable></term> + <listitem> + <para> + Specifies the length of the mode of transport in metres; ensures + that the length limit on the highway is not exceeded. + Default value depends on the profile selected by the + <option>--transport</option> option. + </para> + </listitem> + </varlistentry> + + </variablelist> + + <para> + The meaning of the <replaceable>preference</replaceable> parameter in + the command line options is slightly different for the highway + preferences and the property preferences. + For the highway preference consider the choice between two possible + highways between the start and finish when looking for the shortest + route. + If highway A has a preference of 100% and highway B has a preference of + 90% then highway A will be chosen even if it is up to 11% longer + (100/90 = 111%). + For the highway properties each highway either has a particular property + or not. + If the preference for the property is 60% then a highway with the + property has a preference of 77% (sqrt(60%)) and one without has a + preference of 63% (sqrt(100-60%)). + A highway with the property will be chosen even if it is up to 22% + longer than one without the property (77/63 = 122%). + The overall preference for each highway segment is the product of the + preference for the highway type and all of the preferences for the + highway properties. + </para> + + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + + <example> + <para> + Example usage (motorcycle journey, scenic route, not very fast): + </para> + <screen> +<command>routino-router</command> <option>--dir</option>=<filename>data</filename> <option>--prefix</option>=gb <option>--transport</option>=motorcycle \ + <option>--highway-motorway</option>=0 <option>--highway-trunk</option>=0 \ + <option>--speed-primary</option>=80 <option>--speed-secondary</option>=80 \ + <option>--quickest</option> + </screen> + <para> + This will use the files + <filename>data/gb-nodes.mem</filename>, + <filename>data/gb-segments.mem</filename> and + <filename>data/gb-ways.mem</filename> to find the quickest route by + motorcycle not using motorways or trunk roads and not exceeding 80 + km/hr. + </para> + </example> + + </refsect1> + +</refentry> diff --git a/debian/routino.manpages b/debian/routino.manpages new file mode 100644 index 0000000..13cdaf4 --- /dev/null +++ b/debian/routino.manpages @@ -0,0 +1 @@ +debian/man/*.1 diff --git a/debian/rules b/debian/rules index 645364a..c4d9397 100755 --- a/debian/rules +++ b/debian/rules @@ -9,9 +9,23 @@ # Uncomment this to turn on verbose mode. #export DH_VERBOSE=1 +MANPAGES:=$(wildcard debian/man/*.*.xml) + %: dh $@ +override_dh_clean: + dh_clean debian/man/*.1 + +override_dh_auto_build-arch: + # Create man pages from DocBook XML + for x in $(MANPAGES) ; do \ + docbook2x-man $$x ; \ + mv `basename $$x | sed 's/.xml$$//'` `dirname $$x` ; \ + done + + dh_auto_build + override_dh_auto_install: dh_auto_install install -d $(CURDIR)/debian/tmp/usr/share/routino/www -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/routino.git _______________________________________________ Pkg-grass-devel mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-grass-devel
