1 <?xml version='1.0' encoding='ISO-8859-1'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
7 Process this file with an XSLT processor: `xsltproc \
8 -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
9 manpages/docbook.xsl manpage.dbk'. A manual page
10 <package>.<section> will be generated. You may view the
11 manual page with: nroff -man <package>.<section> | less'. A
12 typical entry in a Makefile or Makefile.am is:
14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
18 manpage.1: manpage.dbk
21 The xsltproc binary is found in the xsltproc package. The
22 XSL files are in docbook-xsl. Please remember that if you
23 create the nroff version in one of the debian/rules file
24 targets (such as build), you will need to include xsltproc
25 and docbook-xsl in your Build-Depends control field.
29 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
30 <!ENTITY dhfirstname "<firstname>Ralf</firstname>">
31 <!ENTITY dhsurname "<surname>Meyer</surname>">
32 <!-- Please adjust the date whenever revising the manpage. -->
33 <!ENTITY dhdate "<date>2008-05-02</date>">
34 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
35 allowed: see man(7), man(1). -->
36 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
37 <!ENTITY dhemail "<email>ranfyy@gmail.com</email>">
38 <!ENTITY dhusername "Ralf Meyer">
39 <!ENTITY dhucpackage "<refentrytitle>VIKING</refentrytitle>">
40 <!ENTITY dhpackage "viking">
42 <!ENTITY debian "<productname>Debian</productname>">
43 <!ENTITY gnu "<acronym>GNU</acronym>">
44 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
47 <refentry xmlns:xi="http://www.w3.org/2001/XInclude">
54 <holder>&dhusername;</holder>
58 <holder>Guilhem Bonnefille</holder>
68 <refname>&dhpackage;</refname>
70 <refpurpose>program to manage GPS data</refpurpose>
74 <command>&dhpackage;</command>
76 <arg choice="plain"><option>-d</option></arg>
77 <arg choice="plain"><option>--debug</option></arg>
80 <arg choice="plain"><option>-V</option></arg>
81 <arg choice="plain"><option>--verbose</option></arg>
83 <arg rep="repeat"><replaceable>file</replaceable></arg>
86 <command>&dhpackage;</command>
88 <arg choice="plain"><option>-h</option></arg>
89 <arg choice="plain"><option>--help</option></arg>
93 <command>&dhpackage;</command>
95 <arg choice="plain"><option>-v</option></arg>
96 <arg choice="plain"><option>--version</option></arg>
101 <title>DESCRIPTION</title>
104 Viking is a free/open source program to manage GPS data. You can
105 import and plot tracks and waypoints, show OpenStreetMap (OSM) maps and/or
106 Terraserver maps under it, add coordinate lines, make new tracks
107 and waypoints, hide different things, etc. It is written in C
108 with the GTK+ 2 toolkit, available for Linux, other POSIX
109 operating systems, and Windows, and is licensed under the GNU GPL.
112 Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
115 <para>This manual page was written for the &debian; distribution
116 because the original program does not have a manual page.
119 <para><command>&dhpackage;</command> is a program to manage GPS data</para>
123 <title>OPTIONS</title>
127 <term><option>file</option></term>
129 <para>Specify file to load at start.</para>
133 <term><option>-d</option></term>
134 <term><option>--debug</option></term>
136 <para>Enable debug output.</para>
140 <term><option>-V</option></term>
141 <term><option>--verbose</option></term>
143 <para>Enable verbose output.</para>
147 <term><option>-?</option></term>
148 <term><option>--help</option></term>
150 <para>Show help options.</para>
154 <term><option>-v</option></term>
155 <term><option>--version</option></term>
157 <para>Show version.</para>
164 <title>Extending Viking</title>
166 <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>
167 <para>Here is an example:
168 <literallayout><![CDATA[
170 <object class="ClassName">
171 <property name="property_name1">Property value</property>
172 <property name="property_name2">Property value</property>
179 <para>You can find more examples in the documentation part of the distribution.</para>
181 <title>Map Source</title>
182 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
183 <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
184 <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
188 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
192 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
195 <term>hostname</term>
196 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
200 <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>
204 <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
208 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
212 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
215 <term>hostname</term>
216 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
220 <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>
224 <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
228 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
232 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
235 <term>hostname</term>
236 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
240 <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>
247 <title>Go-to search engines</title>
248 <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>
249 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
250 <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>
251 <para>The related properties are:
255 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
258 <term>url-format</term>
259 <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>
262 <term>lat-path</term>
263 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
266 <term>lat-attr (optional)</term>
267 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
270 <term>lon-path</term>
271 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
274 <term>lon-attr (optional)</term>
275 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
279 <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>
283 <title>External tools</title>
284 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
285 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
286 <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
287 <para>The related properties are:
291 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
295 <listitem><para>the text displayed in the menu entry</para></listitem>
299 <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>
303 <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
304 <para>The related properties are:
308 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
312 <listitem><para>the text displayed in the menu entry</para></listitem>
316 <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>
328 <term><filename>~/.viking/maps.xml</filename></term>
330 <para>File containing definition of map sources.</para>
331 <para>See previous section for details.</para>
335 <term><filename>~/.viking/goto_tools.xml</filename></term>
337 <para>File containing definition of "Go-to" services.</para>
338 <para>See previous section for details.</para>
342 <term><filename>~/.viking/external_tools.xml</filename></term>
344 <para>File containing definition of external tools.</para>
345 <para>See previous section for details.</para>
349 <term><filename>~/.viking/viking.prefs</filename></term>
351 <para>Preferences for &dhpackage;.</para>
355 <term><filename>~/.viking/cookies.txt</filename></term>
357 <para>File hosting cookies used by &dhpackage;.</para>
361 <term><filename>~/.viking-maps/</filename></term>
363 <para>Map cache of tiles downloaded by &dhpackage;.</para>
368 <para>Extension files (<filename>maps.xml</filename>,
369 <filename>goto_tools.xml</filename>,
370 <filename>external_tools.xml</filename>)
371 are also searched in <filename>/etc/viking</filename> and
372 <filename>/usr/share/viking</filename> directories (or related in your system).</para>
376 <title>ENVIRONMENT</title>
380 <term><envar>XDG_DATA_HOME</envar></term>
382 <para>Optional directory to look for extension files
383 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
384 <filename>external_tools.xml</filename>).</para>
388 <term><envar>XDG_DATA_DIRS</envar></term>
390 <para>Path used to change the directories scanned for extension files
391 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
392 <filename>external_tools.xml</filename>).</para>
399 <title>AUTHOR</title>
401 <para>This manual page was written by &dhusername; &dhemail; for
402 the &debian; system (but may be used by others). Permission is
403 granted to copy, distribute and/or modify this document under
404 the terms of the &gnu; General Public License, Version 2 any
405 later version published by the Free Software Foundation.
408 On Debian systems, the complete text of the GNU General Public
409 License can be found in /usr/share/common-licenses/GPL.