<!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>">
+ <!ENTITY dhdate "<date>2013-04-08</date>">
+ <!-- Would be nice if the version could auto-update. -->
+ <!ENTITY dhsource "Viking">
+ <!ENTITY dhversion "1.4.1">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
+<reference>
+<title>&dhsource; &dhversion;</title>
+
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<address>
<year>2010</year>
<holder>Guilhem Bonnefille</holder>
</copyright>
+ <copyright>
+ <year>2013</year>
+ <holder>Rob Norris</holder>
+ </copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
-
&dhsection;
+ <refmiscinfo CLASS="source">&dhsource;</refmiscinfo>
+ <refmiscinfo CLASS="version">&dhversion;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<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.
+ Viking is a program to manage GPS data.
</para>
<para>
- Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
+ You can import and plot tracks, routes and waypoints, show OpenStreetMap (OSM) maps and/or
+ Terraserver maps under it, add coordinate lines, make new tracks, routes 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.
</para>
-
- <para>This manual page was written for the &debian; distribution
- because the original program does not have a manual page.
+ <para>
+ Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
+ </para>
+ <para>
+ Viking is licensed under the GNU GPL.
</para>
-
- <para><command>&dhpackage;</command> is a program to manage GPS data</para>
</refsect1>
<refsect1>
<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 VikWebtoolCenter 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>
+ <term>label</term>
+ <listitem><para>the text displayed in the menu entry</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>url</term>
+ <listitem><para>the parametrized URL to open, in the spirit of C printf format, with 2 "%s" and a "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/?lat=%s&lon=%s&zoom=%d")</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
+ <para>The related properties are:
+ <variablelist>
<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>
+ <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&right=%s&bottom=%s&top=%s")</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Remote File Datasources</title>
+ <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
+ <para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
+ <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
+ <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para>
+ <para>The related properties are:
+ <variablelist>
+ <varlistentry>
+ <term>label</term>
+ <listitem><para>the text displayed in the menu entry</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url</term>
+ <listitem>
+ <para>the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values. e.g. <literal>http://hostname/getfile?lat=%s&lon=%s</literal></para>
+ <para>The order and meaning of these parameters is given by the url_format_code below</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url_format_code</term>
+ <listitem>
+ <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para>
+ <para>B = Bottom of the current view i.e. minimum latitude</para>
+ <para>L = Left of the current view i.e. minimum longitude</para>
+ <para>T = Top of the current view i.e. maximum latitude</para>
+ <para>R = Right of the current view i.e. maximum longitude</para>
+ <para>A = center lAtitude of the current view</para>
+ <para>O = center lOngitude of the current view</para>
+ <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+ <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>file_type</term>
+ <listitem>
+ <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
+ <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
+ <para>Possible values such as 'kml', 'mapsource' etc.. can be used. See <ulink url="http://www.gpsbabel.org/capabilities.html">GPSBabel File Formats</ulink> for the full list.</para>
+ </listitem>
</varlistentry>
</variablelist>
</para>
<para>See previous section for details.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><filename>~/.viking/datasources.xml</filename></term>
+ <listitem>
+ <para>File containing definition of remote file datasources.</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/viking_layer_defaults.ini</filename></term>
+ <listitem>
+ <para>Layer default values for &dhpackage;.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>~/.viking/viking.ini</filename></term>
+ <listitem>
+ <para>Values for &dhpackage; automatically saved between sessions.</para>
+ <para>Not generally intended to be manually edited.</para>
+ <para>However some finer control of default internal values can be set.</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><filename>~/.viking/cookies.txt</filename></term>
<listitem>
</varlistentry>
</variablelist>
+ <para>Extension files (<filename>maps.xml</filename>,
+ <filename>goto_tools.xml</filename>,
+ <filename>datasources.xml</filename>,
+ <filename>external_tools.xml</filename>)
+ are also searched in <filename>/etc/viking</filename> and
+ <filename>/usr/share/viking</filename> directories (or related in your system).</para>
+
</refsect1>
<refsect1>
- <title>SEE ALSO</title>
+ <title>ENVIRONMENT</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><envar>XDG_DATA_HOME</envar></term>
+ <listitem>
+ <para>Optional directory to look for extension files
+ (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
+ <filename>external_tools.xml</filename>).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><envar>XDG_DATA_DIRS</envar></term>
+ <listitem>
+ <para>Path used to change the directories scanned for extension files
+ (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
+ <filename>external_tools.xml</filename>).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <para>viking-remote (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
- <para>This manual page was written by &dhusername; &dhemail; for
+ <para>This manual page was originally 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
</refsect1>
</refentry>
-
+</reference>