'\" t
.\" Title: VIKING
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1
.\" Date: 2014-03-16
.\" Manual: Viking 1.5.1
.\" Source: Viking
.\" Language: English
.\"
.TH "VIKING" "1" "2014\-03\-16" "Viking" "Viking 1.5.1"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
viking \- program to manage GPS data
.SH "SYNOPSIS"
.HP \w'\fBviking\fR\ 'u
\fBviking\fR [\fB\-d\fR | \fB\-\-debug\fR] [\fB\-V\fR | \fB\-\-verbose\fR] [\fIfile\fR...]
.HP \w'\fBviking\fR\ 'u
\fBviking\fR [\fB\-h\fR | \fB\-\-help\fR]
.HP \w'\fBviking\fR\ 'u
\fBviking\fR [\fB\-v\fR | \fB\-\-version\fR]
.SH "DESCRIPTION"
.PP
Viking is a program to manage GPS data\&.
.PP
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\&.
.PP
Homepage:
\m[blue]\fBhttp://viking\&.sf\&.net\fR\m[]
.PP
Viking is licensed under the GNU GPL\&.
.SH "OPTIONS"
.PP
\fBfile\fR
.RS 4
Specify file to load at start\&.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Enable debug output\&.
.RE
.PP
\fB\-V\fR, \fB\-\-verbose\fR
.RS 4
Enable verbose output\&.
.RE
.PP
\fB\-?\fR, \fB\-\-help\fR
.RS 4
Show help options\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Show version\&.
.RE
.SH "EXTENDING VIKING"
.PP
Currently, viking 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"\&.
.PP
Here is an example:
.sp
.if n \{\
.RS 4
.\}
.nf
\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.PP
You can find more examples in the documentation part of the distribution\&.
.PP
\fBMap Source\fR. It is possible to add new map\*(Aqs sources\&. The file is
~/\&.viking/maps\&.xml\&.
An example of the file in the distribution
doc/examples/maps\&.xml\&.
The VikSlippyMapSource allows to declare any map\*(Aqs source working like OpenStreetMap\&. It supports the following properties:
.PP
id
.RS 4
this is an integer and should be unique as it used to identify the map source
.RE
.PP
label
.RS 4
the text displayed in the map\*(Aqs source selection dialog
.RE
.PP
hostname
.RS 4
the server\*(Aqs hostname (eg\&. "tile\&.openstreetmap\&.org")
.RE
.PP
url
.RS 4
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")
.RE
The VikTmsMapSource allows to declare any TMS service\&. It supports the following properties:
.PP
id
.RS 4
this is an integer and should be unique as it used to identify the map source
.RE
.PP
label
.RS 4
the text displayed in the map\*(Aqs source selection dialog
.RE
.PP
hostname
.RS 4
the server\*(Aqs hostname (eg\&. "tile\&.openstreetmap\&.org")
.RE
.PP
url
.RS 4
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")
.RE
The VikWmscMapSource allows to declare any WMS or WMS\-C service\&. It supports the following properties:
.PP
id
.RS 4
this is an integer and should be unique as it used to identify the map source
.RE
.PP
label
.RS 4
the text displayed in the map\*(Aqs source selection dialog
.RE
.PP
hostname
.RS 4
the server\*(Aqs hostname (eg\&. "tile\&.openstreetmap\&.org")
.RE
.PP
url
.RS 4
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")
.RE
.PP
\fBGo-to search engines\fR. It is possible to add new new search engines for the "Go\-To" feature\&. The file is
~/\&.viking/goto_tools\&.xml\&.
An example of the file in the distribution
doc/examples/goto_tools\&.xml\&.
Currently, there is a single object class available: VikGotoXmlTool\&. Such feature allows to declare any search engine using a XML format as result\&.
The related properties are:
.PP
label
.RS 4
the text displayed in the
Go\-To
dialog
.RE
.PP
url\-format
.RS 4
the parametrized address of the query, in the spirit of C
\fBprintf\fR
format, with a single "%s" field (replaced by the query string)
.RE
.PP
lat\-path
.RS 4
XML path of the latitude (eg\&.
/root/parent/elem)
.RE
.PP
lat\-attr (optional)
.RS 4
name of the attribute (of previous element) containing the latitude
.RE
.PP
lon\-path
.RS 4
XML path of the longitude (eg\&.
/root/parent/elem)
.RE
.PP
lon\-attr (optional)
.RS 4
name of the attribute (of previous element) containing the longiude
.RE
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:
/root/parent/elem@attribute\&.
.PP
\fBExternal tools\fR. It is possible to add new external tools\&. The file is
~/\&.viking/external_tools\&.xml\&.
An example of the file in the distribution
doc/examples/external_tools\&.xml\&.
The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value\&.
The related properties are:
.PP
label
.RS 4
the text displayed in the menu entry
.RE
.PP
url
.RS 4
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")
.RE
The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates\&.
The related properties are:
.PP
label
.RS 4
the text displayed in the menu entry
.RE
.PP
url
.RS 4
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")
.RE
.PP
\fBRemote File Datasources\fR. It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel\&.
The file is
~/\&.viking/datasources\&.xml\&.
An example of the file is in the source distribution
doc/examples/datasources\&.xml\&.
The VikWebtoolDatasource allows to declare any URL using logic based on coordinates\&.
The related properties are:
.PP
label
.RS 4
the text displayed in the menu entry
.RE
.PP
url
.RS 4
the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values\&. e\&.g\&.
http://hostname/getfile?lat=%s&lon=%s
.sp
The order and meaning of these parameters is given by the url_format_code below
.RE
.PP
url_format_code
.RS 4
A string describing the parametrized URL substitution parameters, each character represents how to translate each term\&.
.sp
B = Bottom of the current view i\&.e\&. minimum latitude
.sp
L = Left of the current view i\&.e\&. minimum longitude
.sp
T = Top of the current view i\&.e\&. maximum latitude
.sp
R = Right of the current view i\&.e\&. maximum longitude
.sp
A = center lAtitude of the current view
.sp
O = center lOngitude of the current view
.sp
Z = OSM Zoom value of the current view\&. See
\m[blue]\fBZoom Levels\fR\m[]\&\s-2\u[1]\d\s+2
.sp
Thus for the url example above then the format code should be
\fIAO\fR
.RE
.PP
file_type
.RS 4
This value is passed on for the \-i parameter in interfacing with GPSBabel\&.
.sp
If it is not defined then the returned file is interpreted internally as a GPX file\&.
.sp
Possible values such as \*(Aqkml\*(Aq, \*(Aqmapsource\*(Aq etc\&.\&. can be used\&. See
\m[blue]\fBGPSBabel File Formats\fR\m[]\&\s-2\u[2]\d\s+2
for the full list\&.
.RE
.SH "FILES"
.PP
~/\&.viking/maps\&.xml
.RS 4
File containing definition of map sources\&.
.sp
See previous section for details\&.
.RE
.PP
~/\&.viking/goto_tools\&.xml
.RS 4
File containing definition of "Go\-to" services\&.
.sp
See previous section for details\&.
.RE
.PP
~/\&.viking/external_tools\&.xml
.RS 4
File containing definition of external tools\&.
.sp
See previous section for details\&.
.RE
.PP
~/\&.viking/datasources\&.xml
.RS 4
File containing definition of remote file datasources\&.
.sp
See previous section for details\&.
.RE
.PP
~/\&.viking/viking\&.prefs
.RS 4
Preferences for viking\&.
.RE
.PP
~/\&.viking/viking_layer_defaults\&.ini
.RS 4
Layer default values for viking\&.
.RE
.PP
~/\&.viking/viking\&.ini
.RS 4
Values for viking automatically saved between sessions\&.
.sp
Not generally intended to be manually edited\&.
.sp
However some finer control of default internal values can be set\&.
.RE
.PP
~/\&.viking/cookies\&.txt
.RS 4
File hosting cookies used by viking\&.
.RE
.PP
~/\&.viking\-maps/
.RS 4
Map cache of tiles downloaded by viking\&.
.RE
.PP
Extension files (maps\&.xml,
goto_tools\&.xml,
datasources\&.xml,
external_tools\&.xml) are also searched in
/etc/viking
and
/usr/share/viking
directories (or related in your system)\&.
.SH "ENVIRONMENT"
.PP
\fBXDG_DATA_HOME\fR
.RS 4
Optional directory to look for extension files (maps\&.xml,
goto_tools\&.xml,
external_tools\&.xml)\&.
.RE
.PP
\fBXDG_DATA_DIRS\fR
.RS 4
Path used to change the directories scanned for extension files (maps\&.xml,
goto_tools\&.xml,
external_tools\&.xml)\&.
.RE
.SH "AUTHOR"
.PP
This manual page was originally written by Ralf Meyer
for the
Debian(TM)
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\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2007 Ralf Meyer
.br
Copyright \(co 2010 Guilhem Bonnefille
.br
Copyright \(co 2013 Rob Norris
.br
.SH "NOTES"
.IP " 1." 4
Zoom Levels
.RS 4
\%http://wiki.openstreetmap.org/wiki/Zoom_levels
.RE
.IP " 2." 4
GPSBabel File Formats
.RS 4
\%http://www.gpsbabel.org/capabilities.html
.RE