<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!--
Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'. A manual page
<package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A
typical entry in a Makefile or Makefile.am is:
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet
manpage.1: manpage.dbk
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The
XSL files are in docbook-xsl. Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Ralf</firstname>">
<!ENTITY dhsurname "<surname>Meyer</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>2008-05-02</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>ranfyy@gmail.com</email>">
<!ENTITY dhusername "Ralf Meyer">
<!ENTITY dhucpackage "<refentrytitle>VIKING</refentrytitle>">
<!ENTITY dhpackage "viking">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<address>
&dhemail;
</address>
<copyright>
<year>2007</year>
<holder>&dhusername;</holder>
</copyright>
<copyright>
<year>2010</year>
<holder>Guilhem Bonnefille</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>program to manage GPS data</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<group choice="opt">
<arg choice="plain"><option>-d</option></arg>
<arg choice="plain"><option>--debug</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-V</option></arg>
<arg choice="plain"><option>--verbose</option></arg>
</group>
<arg rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<group choice="opt">
<arg choice="plain"><option>-h</option></arg>
<arg choice="plain"><option>--help</option></arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<group choice="opt">
<arg choice="plain"><option>-v</option></arg>
<arg choice="plain"><option>--version</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
Viking is a free/open source program to manage GPS data. You can
import and plot tracks and waypoints, show OpenStreetMap (OSM) maps and/or
Terraserver maps under it, add coordinate lines, make new tracks
and waypoints, hide different things, etc. It is written in C
with the GTK+ 2 toolkit, available for Linux, other POSIX
operating systems, and Windows, and is licensed under the GNU GPL.
</para>
<para>
Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.
</para>
<para><command>&dhpackage;</command> is a program to manage GPS data</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>file</option></term>
<listitem>
<para>Specify file to load at start.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>Enable debug output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>Enable verbose output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</option></term>
<term><option>--help</option></term>
<listitem>
<para>Show help options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--version</option></term>
<listitem>
<para>Show version.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Extending Viking</title>
<para>Currently, &dhpackage; has some extention points based on configuration files. The file format is heavily inspired by the GtkBuilder file format: you specify the class of the GObject to build and set its properties. Technically, it is a XML file containing a "objects" root element. Inside this element, you set a collection of "object".</para>
<para>Here is an example:
<literallayout><![CDATA[
<objects>
<object class="ClassName">
<property name="property_name1">Property value</property>
<property name="property_name2">Property value</property>
</object>
...
<objects>
]]>
</literallayout>
</para>
<para>You can find more examples in the documentation part of the distribution.</para>
<formalpara>
<title>Map Source</title>
<para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
<para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
<listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
</varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the map's source selection dialog</para></listitem>
</varlistentry>
<varlistentry>
<term>hostname</term>
<listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
</varlistentry>
<varlistentry>
<term>url</term>
<listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
<listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
</varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the map's source selection dialog</para></listitem>
</varlistentry>
<varlistentry>
<term>hostname</term>
<listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
</varlistentry>
<varlistentry>
<term>url</term>
<listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
<listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
</varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the map's source selection dialog</para></listitem>
</varlistentry>
<varlistentry>
<term>hostname</term>
<listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
</varlistentry>
<varlistentry>
<term>url</term>
<listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
</varlistentry>
</variablelist>
</para>
</formalpara>
<formalpara>
<title>Go-to search engines</title>
<para>It is possible to add new new search engines for the "Go-To" feature. The file is <filename>~/.viking/goto_tools.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
<para>Currently, there is a single object class available: VikGotoXmlTool. Such feature allows to declare any search engine using a XML format as result.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
</varlistentry>
<varlistentry>
<term>url-format</term>
<listitem><para>the parametrized address of the query, in the spirit of C <function>printf</function> format, with a single "%s" field (replaced by the query string)</para></listitem>
</varlistentry>
<varlistentry>
<term>lat-path</term>
<listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
</varlistentry>
<varlistentry>
<term>lat-attr (optional)</term>
<listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
</varlistentry>
<varlistentry>
<term>lon-path</term>
<listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
</varlistentry>
<varlistentry>
<term>lon-attr (optional)</term>
<listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>As a facility (or readability) it is possible to set both path and attribute name in a single property, like an XPath expression. To do so, simply set both info in lat-path (or lon-path) in the following format: <literal>/root/parent/elem@attribute</literal>.</para>
</formalpara>
<formalpara>
<title>External tools</title>
<para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
<para>Currently, there is a single object class available: VikWebtoolCenter. Such feature allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
<term>id</term>
<listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
</varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the menu entry</para></listitem>
</varlistentry>
<varlistentry>
<term>url</term>
<listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/%d/%d/%d.png")</para></listitem>
</varlistentry>
</variablelist>
</para>
</formalpara>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>~/.viking/maps.xml</filename></term>
<listitem>
<para>File containing definition of map sources.</para>
<para>See previous section for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.viking/goto_tools.xml</filename></term>
<listitem>
<para>File containing definition of "Go-to" services.</para>
<para>See previous section for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.viking/external_tools.xml</filename></term>
<listitem>
<para>File containing definition of external tools.</para>
<para>See previous section for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.viking/viking.prefs</filename></term>
<listitem>
<para>Preferences for &dhpackage;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.viking/cookies.txt</filename></term>
<listitem>
<para>File hosting cookies used by &dhpackage;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.viking-maps/</filename></term>
<listitem>
<para>Map cache of tiles downloaded by &dhpackage;.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>viking-remote (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>