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>2013-10-13</date>">
34 <!-- Would be nice if the version could auto-update. -->
35 <!ENTITY dhsource "Viking">
36 <!ENTITY dhversion "1.5.0">
37 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
38 allowed: see man(7), man(1). -->
39 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
40 <!ENTITY dhemail "<email>ranfyy@gmail.com</email>">
41 <!ENTITY dhusername "Ralf Meyer">
42 <!ENTITY dhucpackage "<refentrytitle>VIKING</refentrytitle>">
43 <!ENTITY dhpackage "viking">
45 <!ENTITY debian "<productname>Debian</productname>">
46 <!ENTITY gnu "<acronym>GNU</acronym>">
47 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
51 <title>&dhsource; &dhversion;</title>
53 <refentry xmlns:xi="http://www.w3.org/2001/XInclude">
60 <holder>&dhusername;</holder>
64 <holder>Guilhem Bonnefille</holder>
68 <holder>Rob Norris</holder>
75 <refmiscinfo CLASS="source">&dhsource;</refmiscinfo>
76 <refmiscinfo CLASS="version">&dhversion;</refmiscinfo>
79 <refname>&dhpackage;</refname>
81 <refpurpose>program to manage GPS data</refpurpose>
85 <command>&dhpackage;</command>
87 <arg choice="plain"><option>-d</option></arg>
88 <arg choice="plain"><option>--debug</option></arg>
91 <arg choice="plain"><option>-V</option></arg>
92 <arg choice="plain"><option>--verbose</option></arg>
94 <arg rep="repeat"><replaceable>file</replaceable></arg>
97 <command>&dhpackage;</command>
99 <arg choice="plain"><option>-h</option></arg>
100 <arg choice="plain"><option>--help</option></arg>
104 <command>&dhpackage;</command>
106 <arg choice="plain"><option>-v</option></arg>
107 <arg choice="plain"><option>--version</option></arg>
112 <title>DESCRIPTION</title>
115 Viking is a program to manage GPS data.
118 You can import and plot tracks, routes and waypoints, show OpenStreetMap (OSM) maps and/or
119 Terraserver maps under it, add coordinate lines, make new tracks, routes and waypoints, hide different things, etc.
120 It is written in C with the GTK+ 2 toolkit, available for Linux, other POSIX operating systems and Windows.
123 Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
126 Viking is licensed under the GNU GPL.
131 <title>OPTIONS</title>
135 <term><option>file</option></term>
137 <para>Specify file to load at start.</para>
141 <term><option>-d</option></term>
142 <term><option>--debug</option></term>
144 <para>Enable debug output.</para>
148 <term><option>-V</option></term>
149 <term><option>--verbose</option></term>
151 <para>Enable verbose output.</para>
155 <term><option>-?</option></term>
156 <term><option>--help</option></term>
158 <para>Show help options.</para>
162 <term><option>-v</option></term>
163 <term><option>--version</option></term>
165 <para>Show version.</para>
172 <title>Extending Viking</title>
174 <para>Currently, &dhpackage; has some extension 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>
175 <para>Here is an example:
176 <literallayout><![CDATA[
178 <object class="ClassName">
179 <property name="property_name1">Property value</property>
180 <property name="property_name2">Property value</property>
187 <para>You can find more examples in the documentation part of the distribution.</para>
189 <title>Map Source</title>
190 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
191 <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
192 <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
196 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
200 <listitem><para>a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (<filename>~/.viking-maps</filename>)</para></listitem>
204 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
207 <term>hostname</term>
208 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
212 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for Z, X and Y (in that order) (eg. "/%d/%d/%d.png")</para></listitem>
215 <term>zoom-min (optional)</term>
216 <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
219 <term>zoom-max (optional)</term>
221 <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
222 <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
226 <term>switch-xy (optional)</term>
227 <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
231 <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
235 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
239 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
242 <term>hostname</term>
243 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
247 <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>
251 <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
255 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
259 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
262 <term>hostname</term>
263 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
267 <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>
274 <title>Go-to search engines</title>
275 <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>
276 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
277 <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>
278 <para>The related properties are:
282 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
285 <term>url-format</term>
286 <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>
289 <term>lat-path</term>
290 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
293 <term>lat-attr (optional)</term>
294 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
297 <term>lon-path</term>
298 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
301 <term>lon-attr (optional)</term>
302 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
306 <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>
310 <title>External tools</title>
311 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
312 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
313 <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
314 <para>The related properties are:
318 <listitem><para>the text displayed in the menu entry</para></listitem>
322 <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>
326 <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
327 <para>The related properties are:
331 <listitem><para>the text displayed in the menu entry</para></listitem>
335 <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>
342 <title>Remote File Datasources</title>
343 <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
344 <para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
345 <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
346 <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para>
347 <para>The related properties are:
351 <listitem><para>the text displayed in the menu entry</para></listitem>
356 <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>
357 <para>The order and meaning of these parameters is given by the url_format_code below</para>
361 <term>url_format_code</term>
363 <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para>
364 <para>B = Bottom of the current view i.e. minimum latitude</para>
365 <para>L = Left of the current view i.e. minimum longitude</para>
366 <para>T = Top of the current view i.e. maximum latitude</para>
367 <para>R = Right of the current view i.e. maximum longitude</para>
368 <para>A = center lAtitude of the current view</para>
369 <para>O = center lOngitude of the current view</para>
370 <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
371 <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
375 <term>file_type</term>
377 <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
378 <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
379 <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>
392 <term><filename>~/.viking/maps.xml</filename></term>
394 <para>File containing definition of map sources.</para>
395 <para>See previous section for details.</para>
399 <term><filename>~/.viking/goto_tools.xml</filename></term>
401 <para>File containing definition of "Go-to" services.</para>
402 <para>See previous section for details.</para>
406 <term><filename>~/.viking/external_tools.xml</filename></term>
408 <para>File containing definition of external tools.</para>
409 <para>See previous section for details.</para>
413 <term><filename>~/.viking/datasources.xml</filename></term>
415 <para>File containing definition of remote file datasources.</para>
416 <para>See previous section for details.</para>
420 <term><filename>~/.viking/viking.prefs</filename></term>
422 <para>Preferences for &dhpackage;.</para>
426 <term><filename>~/.viking/viking_layer_defaults.ini</filename></term>
428 <para>Layer default values for &dhpackage;.</para>
432 <term><filename>~/.viking/viking.ini</filename></term>
434 <para>Values for &dhpackage; automatically saved between sessions.</para>
435 <para>Not generally intended to be manually edited.</para>
436 <para>However some finer control of default internal values can be set.</para>
440 <term><filename>~/.viking/cookies.txt</filename></term>
442 <para>File hosting cookies used by &dhpackage;.</para>
446 <term><filename>~/.viking-maps/</filename></term>
448 <para>Map cache of tiles downloaded by &dhpackage;.</para>
453 <para>Extension files (<filename>maps.xml</filename>,
454 <filename>goto_tools.xml</filename>,
455 <filename>datasources.xml</filename>,
456 <filename>external_tools.xml</filename>)
457 are also searched in <filename>/etc/viking</filename> and
458 <filename>/usr/share/viking</filename> directories (or related in your system).</para>
462 <title>ENVIRONMENT</title>
466 <term><envar>XDG_DATA_HOME</envar></term>
468 <para>Optional directory to look for extension files
469 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
470 <filename>external_tools.xml</filename>).</para>
474 <term><envar>XDG_DATA_DIRS</envar></term>
476 <para>Path used to change the directories scanned for extension files
477 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
478 <filename>external_tools.xml</filename>).</para>
485 <title>AUTHOR</title>
487 <para>This manual page was originally written by &dhusername; &dhemail; for
488 the &debian; system (but may be used by others). Permission is
489 granted to copy, distribute and/or modify this document under
490 the terms of the &gnu; General Public License, Version 2 any
491 later version published by the Free Software Foundation.
494 On Debian systems, the complete text of the GNU General Public
495 License can be found in /usr/share/common-licenses/GPL.