'\" t
.\" Title: VIKING
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 2026-05-01
.\" Manual: Viking 1.11
.\" Source: Viking
.\" Language: English
.\"
.TH "VIKING" "1" "2026\-05\-01" "Viking" "Viking 1.11"
.\" -----------------------------------------------------------------
.\" * 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]
.br
[\fB\-\-latitude\fR\ \fIdegrees\fR\ \fB\-\-longitude\fR\ \fIdegrees\fR]
.br
[\fB\-z\fR | \fB\-\-zoom\fR\ \fIZoomLevelOSM\fR] [\fB\-m\fR | \fB\-\-map\fR\ \fIMapId\fR]
.br
[\fB\-c\fR | \fB\-\-config\-dir\fR\ \fIdirectory\fR] [\fB\-e\fR | \fB\-\-external\fR] [\fB\-r\fR | \fB\-\-running\-instance\fR]
.br
[\fIfile\fR...] | [\fI\-\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) and/or other maps, generate maps (using Mapnik), geotag images, add coordinate lines, make new tracks, routes and waypoints, hide different things, etc\&. It is written mainly in C with some C++ and uses the GTK+ 3 toolkit\&. It is 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\&.
.PP
Viking also provides a more extensive manual accessible via the program that expands on some of the concepts introduced here\&.
.SH "DETAILS"
Details.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&File Reference
.TS
allbox tab(:);
lB lB.
T{
Values
T}:T{
Description
T}
.T&
l l
l l.
T{
file(s)
T}:T{
Read the specified files in sequence left to right
T}
T{
\-
T}:T{
Read input from standard in\&. No other files should be specified
T}
.TE
.sp 1
.PP
.PP
Note that the ordering of files can be important depending on their file type\&. Subsequent non Viking project files are loaded into the previous Viking project, with the files being processed left to right\&. Some examples:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viking file1\&.gpx file2\&.gpx file3\&.gpx
.sp
Here all GPX files are loaded into a new Viking project in one window\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viking file1\&.vik file2\&.vik
.sp
Each Viking project file is opened in a new window\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viking file1\&.vik file2\&.gpx file3\&.gpx
.sp
The GPX files are loaded into the Viking project in one window\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viking file2\&.gpx file3\&.gpx file1\&.vik
.sp
The GPX files are loaded into a new Viking project in a one window and the Viking project is loaded seperately in a seperate window\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&2.\ \&Command Line Reference
.TS
allbox tab(:);
lB lB lB.
T{
Short Option
T}:T{
Long Option
T}:T{
Description
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
\-h
T}:T{
\-\-help
T}:T{
Show the command line options and then exit\&.
T}
T{
\-V
T}:T{
\-\-verbose
T}:T{
Run in verbose mode\&. Some information about what Viking is doing is shown in stdout\&.
T}
T{
\-d
T}:T{
\-\-debug
T}:T{
Run in debug mode\&. Even more information about what Viking is doing is shown in stdout\&.
This also enables some extra information features in the GUI itself, primarily of interest to developers\&.
T}
T{
\-v
T}:T{
\-\-version
T}:T{
Show the version and then exit\&.
T}
T{
N/A
T}:T{
\-\-latitude
T}:T{
Set the initial position to the specified latitude in decimal degrees\&.
T}
T{
N/A
T}:T{
\-\-longitude
T}:T{
Set the initial position to the specified longitude in decimal degrees\&.
T}
T{
\-z
T}:T{
\-\-zoom
T}:T{
Set the initial zoom level\&. The value is the OSM zoom level (0 \- 22)\&.
T}
T{
\-m
T}:T{
\-\-map
T}:T{
Add a map layer by specifying the map id\&. The value needs to match one of the internal ids or an id from the Map Source Extensions\&.
Specifying a value of 0 will use the map layer default\&.
Specifying any negative value e\&.g\&. \-2 will not show a map (overriding the GUI preference that automatically adds one at startup)
T}
T{
\-e
T}:T{
\-\-external
T}:T{
The files specified on the command line will be loaded in as \fIexternal files\fR as per the External reference:??? method\&.
Applies to GPX, FIT, KML or TCX types, thus has no effect on \&.vik files\&.
T}
T{
\-c
T}:T{
\-\-config\-dir
T}:T{
Use an alternate location (which will be created if it does not exist) for the configuration directory\&.
This is useful for using/trying specific configuration values for a particular session without changing ones normal settings\&.
T}
T{
\-r
T}:T{
\-\-running\-instance
T}:T{
Opens the specified files in an already running instance of Viking\&. If no instance is available than the files will not be opened\&.
Positional and map option parameters are not used or passed on to the running instance\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
This option is not available on
Windows(TM)
.sp .5v
.RE
T}
.TE
.sp 1
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&3.\ \&Internal Map Ids
.TS
allbox tab(:);
lB lB.
T{
Map
T}:T{
Id
T}
.T&
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
4UMaps
T}:T{
801
T}
T{
Bing Aerial
T}:T{
212
T}
T{
Blue Marble
T}:T{
15
T}
T{
CalTopo
T}:T{
29
T}
T{
CyclOSM
T}:T{
65
T}
T{
pnvkarte Public Transport
T}:T{
101
T}
T{
OpenSeaMap
T}:T{
600
T}
T{
OpenTopo
T}:T{
901 (current default)
T}
T{
OSM Cycle
T}:T{
17
T}
T{
OSM Humanitarian
T}:T{
22
T}
T{
OSM Mapnik
T}:T{
13
T}
T{
OSM Transport
T}:T{
20
T}
T{
OSM GPS Traces
T}:T{
33
T}
T{
Waymarked Trails Cycling
T}:T{
702
T}
T{
Waymarked Trails Hiking
T}:T{
701
T}
T{
Waymarked Trails MTB
T}:T{
703
T}
T{
Waymarked Trails Riding
T}:T{
705
T}
T{
Waymarked Trails Skating
T}:T{
704
T}
T{
Waymarked Trails Winter
T}:T{
706
T}
.TE
.sp 1
.PP
The current list of available Maps and their Id, including the built in ones listed above plus any additional ones added by extended configuration, can be viewed in the main program by going to
Help → Maps Information
.PP
An example to open at a specified location with an OSM Mapnik map layer:
.sp
.if n \{\
.RS 4
.\}
.nf
viking \-\-latitude 51\&.4 \-\-longitude \-1\&.3 \-\-zoom 12 \-\-map 13
.fi
.if n \{\
.RE
.\}
.sp
If a file is also specified on the command line, the command line location and zoom parameters will take precedence\&.
.PP
Viking supports
\m[blue]\fBRFC5870\fR\m[]\&\s-2\u[1]\d\s+2, the \*(Aqgeo\*(Aq URI scheme\&. Every \*(Aqfile\*(Aq on the command line is checked to see if in fact it is a geo URI\&. Thus the above example in geo URI format is:
.sp
.if n \{\
.RS 4
.\}
.nf
viking geo:51\&.4,\-1\&.3?z=12 \-\-map 13
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
As a special combination when both
\fI\-V and \-d\fR
are both enabled at the same time, Viking will not delete some of the temporary files created during the program run\&. This is especially useful to monitor results of download requests (which need to be interpreted) if they suddenly start failing, as the file will have often more detailed information about the failure mode\&.
.sp .5v
.RE
.PP
Viking being a GTK+ program means some options are processed by GTK+ itself such as \-\-display\&. Use the following to find out what they are for your system:
.sp
.if n \{\
.RS 4
.\}
.nf
viking \-\-help\-gtk
.fi
.if n \{\
.RE
.\}
.sp
.SH "EXTENDING VIKING"
Extending Viking.PP
Overview.PP
.PP
Currently, Viking 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"\&.
.PP
Here is an example:
.sp
.if n \{\
.RS 4
.\}
.nf
\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.PP
You can find more examples as installed on your system and in the documentation part of the distribution\&. Typically these will be installed into one of the $XDG_DATA_DIR locations, such as
/usr/share/viking/
or
C:\eProgram Files\eViking\edata
depending on the Operating System\&.
.PP
It is also possible to override the internal defaults e\&.g\&. to update any parameters should they change over time, by adding the values into your configuration file\&. When you define object group that already exists (and for Maps this means by a repeated Id key, but you may have to examine the source code to work out what the relevant Id values are) then you need to define all the other keys as well, otherwise they will be reset to the defaults\&.
.PP
Map Sources.PP
It is possible to add new map sources\&. The file is
maps\&.xml
placed in your
User Configuration File Location\&.
.PP
An example of the file is in the distribution
doc/examples/maps\&.xml\&. Further examples and values are online in the
\m[blue]\fBMaps Wiki\fR\m[]\&\s-2\u[2]\d\s+2
.PP
The
VikSlippyMapSource
allows declaration of any map 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
name
.RS 4
a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (~/\&.viking\-maps)
.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 parameterised 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")
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
The full parameterised address can just be put in the URL field and the hostname field doesn\*(Aqt need specifying\&.
.sp
e\&.g\&. "https://tile\&.openstreetmap\&.org/%d/%d/%d\&.png"
.sp .5v
.RE
.RE
.PP
user\-agent (optional)
.RS 4
Override the default user\-agent used in the HTTP request\&.
.RE
.PP
custom\-http\-headers (optional)
.RS 4
Custom HTTP headers to be added to the download request\&. The default is none\&.
.sp
Multiple headers can be specified by separating each part with an \*(Aq\en\*(Aq\&.
.sp
The header allows of substitutions of values of the positional Z, X and Y (in that order) values, as per the
\fIurl\fR
option above\&. Using multiple and/or different ordered values can be acheived via printf() positional argument specifiers\&. For example:
.sp
DNT: 1\enLine2: %d %d %d\enReordered: %3$d %1$d %2$d
.RE
.PP
copyright (optional)
.RS 4
The copyright of the map source\&.
.RE
.PP
license (optional)
.RS 4
The license of the map source\&.
.RE
.PP
license\-url (optional)
.RS 4
The URL of the license of the map source\&.
.RE
.PP
zoom\-min (optional)
.RS 4
The minimum Tiled Web Map zoom value supported by the tile server\&. The Default is 0 if not specified\&.
.RE
.PP
zoom\-max (optional)
.RS 4
The maximum Tiled Web Map zoom value supported by the tile server\&. The Default is 18 if not specified\&.
.RE
.PP
lat\-min (optional)
.RS 4
The minimum latitude value in degrees supported by the tile server\&. The Default is \-90 degrees if not specified\&.
.RE
.PP
lat\-max (optional)
.RS 4
The maximum latitude value in degrees supported by the tile server\&. The Default is 90 degrees if not specified\&.
.RE
.PP
lon\-min (optional)
.RS 4
The minimum longitude value in degrees supported by the tile server\&. The Default is \-180 degrees if not specified\&.
.RE
.PP
lon\-max (optional)
.RS 4
The maximum longitude value in degrees supported by the tile server\&. The Default is 180 degrees if not specified\&.
.RE
.PP
file\-extension (optional)
.RS 4
The file extension of the files on disk\&. The default is
\fI\&.png\fR
.sp
If the tile source is not a PNG file, then this parameter can be used to specify the naming to give consistent extension filenames on disk\&.
.sp
This can also be useful in reading a tileset from other software which may name tiles in an alternative form, e\&.g\&. for Mobile Atlas creator it names them
\fI\&.png\&.tile\fR
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG\&.
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
Remember to include the beginning
\fI\*(Aq\&.\*(Aq\fR
when specifying this parameter\&.
.sp .5v
.RE
.RE
.PP
use\-direct\-file\-access (optional)
.RS 4
Only use files on disk\&. The default is
\fIFALSE\fR
.sp
This can also be useful for tilesets already on disk as it will avoid attempting to download any tiles\&.
.sp
Thus with this type the
\fIhostname\fR
and
\fIurl\fR
parameters are not necessary and are ignored\&.
.RE
.PP
offset\-x (optional)
.RS 4
The offset of the map in the x plane (towards east) in metres\&. The default is 0\&.0 if not specified\&.
.sp
Use negative numbers to adjust in a westerly direction\&.
.sp
Typical usage would be aligning differing maps, e\&.g\&. aerial imagery may be offset from cadastral maps\&.
.sp
Currently this is a single value that applies to all zoom levels\&.
.RE
.PP
offset\-y (optional)
.RS 4
The offset of the map in the y plane (towards north) in metres\&. The default is 0\&.0 if not specified\&.
.sp
Use negative numbers to adjust in a southerly direction\&.
.RE
.PP
switch\-xy (optional)
.RS 4
Swap the X,Y values around in the URL parameterised ordering\&.
.sp
The default is false\&.
.RE
.PP
check\-file\-server\-time (optional)
.RS 4
Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not\&.
.sp
The default is true\&.
.RE
.PP
use\-etag (optional)
.RS 4
Use and compare the
\m[blue]\fBETag\fR\m[]\&\s-2\u[3]\d\s+2
value in determining whether to download a newer tile\&. The default is false\&.
.sp
The ETag value is stored in a separate file in the same directory as the tile to enable checking the value across multiple runs of the program\&.
.RE
.PP
referer (optional)
.RS 4
A URL to serve as referrer for the HTTP request (eg\&. "http://hostname/")
.RE
.PP
follow\-location (optional)
.RS 4
The maximum number of redirects allowed\&. The default is \-1 for an unlimited number of redirects\&. Use 0 if you do not want to follow redirects\&.
.RE
.PP
tilesize\-x (optional)
.RS 4
The tile x size\&. The default is 256 pixels if not specified\&.
.RE
.PP
tilesize\-y (optional)
.RS 4
The tile y size\&. The default is 256 pixels if not specified\&.
.RE
.PP
scale (optional)
.RS 4
The tile scale\&. The scale is 1 if not specified\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
Use a value of 2 to represent high res tiles\&. Don\*(Aqt change the tilesize as the internal display size is still based on 256 pixels\&.
.sp .5v
.RE
.RE
.PP
.PP
The
VikTmsMapSource
allows declaration of any TMS service\&. A TMS (Tile Map Service) is defined in
\m[blue]\fBTile Map Service Specification\fR\m[]\&\s-2\u[4]\d\s+2\&. The configuration supports the following properties (as per
VikSlippyMapSource
above):
.PP
.RS 4
id
.RE
.RS 4
label
.RE
.RS 4
hostname
.RE
.RS 4
url
.RE
.RS 4
custom\-http\-headers (optional)
.RE
.RS 4
copyright (optional)
.RE
.RS 4
license (optional)
.RE
.RS 4
license\-url (optional)
.RE
.RS 4
check\-file\-server\-time (optional)
.RE
.RS 4
follow\-location (optional)
.RE
.RS 4
referer (optional)
.RE
.RS 4
user\-agent (optional)
.RE
.RS 4
zoom\-min (optional)
.RE
.RS 4
zoom\-max (optional)
.RE
.RS 4
lat\-min (optional)
.RE
.RS 4
lat\-max (optional)
.RE
.RS 4
lon\-min (optional)
.RE
.RS 4
lon\-max (optional)
.RE
.RS 4
file\-extension (optional)
.RE
.RS 4
scale (optional)
.RE
.RS 4
tilesize\-x (optional)
.RE
.RS 4
tilesize\-y (optional)
.RE
.RS 4
offset\-x (optional)
.RE
.RS 4
offset\-y (optional)
.RE
.PP
.PP
The
VikWmscMapSource
allows declaration of any WMS or WMS\-C service\&. A WMS (Web Map Service) is defined in
\m[blue]\fBWMS Tile Caching\fR\m[]\&\s-2\u[5]\d\s+2\&. The configuration supports the following properties (as per
VikSlippyMapSource
above):
.PP
.RS 4
id
.RE
.RS 4
label
.RE
.RS 4
hostname
.RE
.RS 4
url
.RE
.RS 4
custom\-http\-headers (optional)
.RE
.RS 4
copyright (optional)
.RE
.RS 4
license (optional)
.RE
.RS 4
license\-url (optional)
.RE
.RS 4
check\-file\-server\-time (optional)
.RE
.RS 4
follow\-location (optional)
.RE
.RS 4
referer (optional)
.RE
.RS 4
user\-agent (optional)
.RE
.RS 4
zoom\-min (optional)
.RE
.RS 4
zoom\-max (optional)
.RE
.RS 4
lat\-min (optional)
.RE
.RS 4
lat\-max (optional)
.RE
.RS 4
lon\-min (optional)
.RE
.RS 4
lon\-max (optional)
.RE
.RS 4
file\-extension (optional)
.RE
.RS 4
scale (optional)
.RE
.RS 4
tilesize\-x (optional)
.RE
.RS 4
tilesize\-y (optional)
.RE
.RS 4
offset\-x (optional)
.RE
.RS 4
offset\-y (optional)
.RE
Go\-to Search Engines.PP
It is possible to add new new search engines for the "Go\-To" feature\&. The file is
goto_tools\&.xml
placed in your
User Configuration File Location\&.
.PP
An example of the file in the distribution
doc/examples/goto_tools\&.xml\&.
.PP
Currently, there is a single object class available:
VikGotoXmlTool\&. This feature allows one to declare any search engine using a XML format as result\&.
.PP
The related properties are:
.PP
label
.RS 4
the text displayed in the
Go\-To
dialog
.RE
.PP
url\-format
.RS 4
the parameterised 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
.PP
referer (optional)
.RS 4
A URL to serve as referer for the HTTP request (eg\&. "http://hostname/")
.RE
.PP
follow\-location (optional)
.RS 4
The maximum number of redirects allowed\&. The default is \-1 for an unlimited number of redirects\&. Use 0 if you do not want to follow redirects\&.
.RE
.PP
user\-agent (optional)
.RS 4
Override the default user\-agent used in the HTTP request\&.
.RE
.PP
custom\-http\-headers (optional)
.RS 4
Custom HTTP headers to be added to the HTTP request\&. The default is none\&.
.sp
Note that unlike custom\-http\-headers for Tile download requests, it does not perform any value substitions in this string\&.
.RE
.PP
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\&.
External Tools.PP
It is possible to add new external tools\&. The file is
external_tools\&.xml
placed in your
User Configuration File Location\&.
.PP
An example of the file in the distribution
doc/examples/external_tools\&.xml\&.
.PP
The
VikWebtoolCenter
allows one to declare any Webtool using a logic based on center coordinates and zoom level value\&.
.PP
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
.PP
The
VikWebtoolBounds
allows one to declare any Webtool using a logic based on bounds coordinates\&.
.PP
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
Routing Engines.PP
It is possible to declare new routing engines\&. The file is
routing\&.xml
placed in your
User Configuration File Location\&.
.PP
An example of the file in the distribution
doc/examples/routing\&.xml\&.
.PP
The
VikRoutingWebEngine
allows one to declare a routing engine available via HTTP\&.
.PP
The related properties are:
.PP
id
.RS 4
a string, should be unique as it used to identify the routing engine
.RE
.PP
label
.RS 4
the text displayed in the menu entry
.RE
.PP
format
.RS 4
The
GPSBabel
format code to interpret the service response\&. By default a GPX response is expected and processed internally\&. However if the service returns a different format then
GPSBabel
is used to transform the text into something that Viking can understand\&. Only formats that
GPSBabel
supports can be used: e\&.g\&.
\fIgtrnctr\fR
(for Garmin Training Center \&.tcx files), etc\&.\&.\&.
.sp
Use
\fBgpsbabel \-\-help\fR
on the command line to find out the supported file types and their codes to process them\&.
.sp
Some format codes are handled natively by Viking such as
\fIgpx\fR
and
\fIkml\fR\&.
.sp
A special format code of
\fIviking\-geojson\-osrm\fR
is available for handling responses by
\m[blue]\fBOSRM\fR\m[]\&\s-2\u[6]\d\s+2
route servers\&.
.RE
.PP
url\-base
.RS 4
the base URL of the web service (eg\&. "http://hostname/service?")
.RE
.PP
url\-start\-ll
.RS 4
the part of the URL setting the starting point location, parameterised in the spirit of C printf format, with 2 "%s" for coordinates (eg\&. "&start=%s,%s")
.RE
.PP
url\-stop\-ll
.RS 4
the part of the URL setting the end point location, parameterised in the spirit of C printf format, with 2 "%s" for coordinates (eg\&. "&stop=%s,%s")
.RE
.PP
url\-via\-ll (optional)
.RS 4
the part of the URL setting via point location, parameterised in the spirit of C printf format, with 2 "%s" for coordinates (eg\&. "&via=%s,%s")
.RE
.PP
url\-start\-dir (optional)
.RS 4
the part of the URL setting the starting point location for direction based routing, parameterised in the spirit of C printf format, with one "%s" for direction (eg\&. "&start=%s")
.RE
.PP
url\-stop\-dir (optional)
.RS 4
the part of the URL setting the end point location for direction based routing, parameterised in the spirit of C printf format, with one "%s" for direction (eg\&. "&stop=%s")
.RE
.PP
url\-ll\-lat\-first (optional)
.RS 4
The ordering of the lat/long terms in the Start, Stop and Via URL settings\&. By default this is TRUE\&.
.sp
For instance using Brouter services, the URL uses a pair of values which is longitude and then latitude\&. Thus setting this value to FALSE ensures the value substitution is performed in the necessary order\&.
.RE
.PP
referer (optional)
.RS 4
A URL to serve as referer for the HTTP request (eg\&. "http://hostname/")
.RE
.PP
follow\-location (optional)
.RS 4
The maximum number of redirects allowed\&. The default is \-1 for an unlimited number of redirects\&. Use 0 if you do not want to follow redirects\&.
.RE
.PP
user\-agent (optional)
.RS 4
Override the default user\-agent used in the HTTP request\&.
.RE
.PP
custom\-http\-headers (optional)
.RS 4
Custom HTTP headers to be added to the HTTP request\&. The default is none\&.
.sp
Note that unlike custom\-http\-headers for Tile download requests, it does not perform any value substitutions in this string\&.
.RE
Remote File Datasources.PP
It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel\&.
.PP
The file is
datasources\&.xml
placed in your
User Configuration File Location\&.
.PP
An example of the file is in the source distribution
doc/examples/datasources\&.xml\&.
.PP
The
VikWebtoolDatasource
allows one to declare any URL using logic based on coordinates\&.
.PP
The related properties are:
.PP
label
.RS 4
the text displayed in the menu entry
.RE
.PP
url
.RS 4
the parameterised URL to open in the spirit of C printf format, with up to 9 "%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 parameterised 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[7]\d\s+2
.sp
P = selected Point\*(Aqs latitude
.sp
N = selected poiNt\*(Aqs longitude
.sp
S = A user specified input string requested from the user via a dialog box
.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[8]\d\s+2
for the full list\&.
.RE
.PP
babel_filter_args
.RS 4
This value is passed on for the filter arguments interfacing with GPSBabel\&.
.sp
E\&.g\&. "\-x nuketypes,routes" can be used to filter all routes from the results\&.
.RE
.PP
input_label
.RS 4
This value is used when requesting input from the user\&.
.sp
It is the label of the text input box\&.
.RE
.PP
referer (optional)
.RS 4
A URL to serve as referrer for the HTTP request (eg\&. "http://hostname/")
.RE
.PP
follow\-location (optional)
.RS 4
The maximum number of redirects allowed\&. The default is \-1 for an unlimited number of redirects\&. Use 0 if you do not want to follow redirects\&.
.RE
.PP
user\-agent (optional)
.RS 4
Override the default user\-agent used in the HTTP request\&.
.RE
.PP
custom\-http\-headers (optional)
.RS 4
Custom HTTP headers to be added to the HTTP request\&. The default is none\&.
.RE
System Extension File Locations.PP
Note that, on
UNIX(TM)
like systems, the extension files (maps\&.xml,
goto_tools\&.xml,
datasources\&.xml,
external_tools\&.xml,
routing\&.xml) are also searched in
/etc/viking
and
/usr/share/viking
directories (or related in your system)\&.
.PP
The
\fB$XDG_DATA_DIRS\fR
environment variable can be used to change these directories\&.
.PP
The
\fB$XDG_DATA_HOME\fR
environment variable is also used (if set) to look for these extension files\&.
.SH "FILES"
Configuring Viking.PP
User Configuration File Location.PP
.PP
Viking looks for its configuration files (viking\&.prefs,
viking\&.ini,
viking\&.ini
and
keys\&.rc) in a specific directory, searching legacy locations first before trying new locations\&. Thus if you upgrade Viking it will continue to use your existing setup\&.
.PP
For
UNIX(TM)
like systems:
.PP
Up to v1\&.8
.RS 4
~/\&.viking/
.sp
(typically
/home/\fIusername\fR/\&.viking)
.RE
.PP
From v1\&.9 onwards
.RS 4
\m[blue]\fBXDG Base Directory compliant\fR\m[]\&\s-2\u[9]\d\s+2
.sp
Typically
~/config/viking/
.RE
.PP
For
Windows(TM)
systems:
.PP
v1\&.8 or earlier
.RS 4
C:\eUsers\e\fIusername\fR\e\&.viking
.RE
.PP
v1\&.9 onwards
.RS 4
C:\eUsers\e\fIusername\fR\eAppData\eLocal\eviking
.RE
.PP
For
Mac(TM):
.PP
/Library/Application Support/Viking
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
If you\*(Aqve upgraded
Viking
to v1\&.9 and want it to use the new location, you will have to manually move the existing directory (when
Viking
is not running)\&. e\&.g\&. in the command line:
\fBmv ~/\&.viking ~/\&.config/viking\fR
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
The User Configuration File Location directory can be overridden for the current session by explicitly setting the configuration directory via the
\fI\-\-config\-dir\fR
command line option\&. See
the section called \(lqDetails\(rq
for more detail\&.
.sp .5v
.RE
Primary Settings.PP
Viking\*(Aqs primary configuration options are controllable via the GUI as previously covered in Preferences:???\&.
.PP
These values are stored in the plain text file
viking\&.prefs
Miscellaneous Settings.PP
Various individual values are automatically saved between
Viking
sessions in the
viking\&.ini
file placed in your
User Configuration File Location\&.
.PP
This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired\&.
.PP
Some values in this file are
\fInon\-GUI\fR, in the sense that there is no way to set it other than by manually entering in the keys and values (the key will not exist in the file otherwise)\&. This allows some fine tuning of
Viking
behaviours, without resorting to recompiling the code\&. However is it not expected that these values should need to be changed for a normal user, hence no GUI options for these have been provided\&.
.PP
Here is the list of the
\fInon\-GUI\fR
keys and their default values\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
curl_cainfo=NULL
.sp
See
\m[blue]\fBCURLOPT_CAINFO\fR\m[]\&\s-2\u[10]\d\s+2
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
For
UNIX(TM)
like systems: curl_ssl_verifypeer=1
.sp
For
Windows(TM)
systems: curl_ssl_verifypeer=0
.sp
See
\m[blue]\fBCURLOPT_SSL_VERIFYPEER\fR\m[]\&\s-2\u[11]\d\s+2
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If you encounter issues downloading from https sources, setting this to 0 should get HTTPS connections to work\&. For
UNIX(TM)
like operating systems SSL Certificate management is typically handled system wide and trusted certficate issuers updated regularly\&. Whereas for Viking under Windows this is only done at installation/version update time and so may become out of date or encounter unknown sources and thus more likely to raise verification failures\&. Hence this is why is is turned off by default on
Windows(TM)
\- especially to ensure the default Maps of OpenTopoMap work without manual user intervention\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
curl_user_agent=NULL
.sp
Override the default HTTP User\-Agent (which is otherwise generated automatically from a combination of Viking\*(Aqs name, the version and curl information) set in all download requests with the value specified\&.
.sp
Also see
\m[blue]\fBCURLOPT_USERAGENT\fR\m[]\&\s-2\u[12]\d\s+2
.sp
NB The User Agent for individual downloads/requests can be set via the relevant
\fIuser\-agent\fR
property when defining use of additional resources\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
export_gpsmapper_option=false
.sp
To enable the export to the little used GPS Mapper format option, set this to true\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
export_gpspoint_option=false
.sp
To enable the export to the little used GPS Point format option, set this to true\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
geoclue_accuracy_level=4
.sp
Set the integer value for the accuracy level request to the GeoClue service\&. Values to match the
\m[blue]\fBGClueAccuracyLevel\fR\m[]\&\s-2\u[13]\d\s+2:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
0 = GCLUE_ACCURACY_LEVEL_NONE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
1 = GCLUE_ACCURACY_LEVEL_COUNTRY
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
4 = GCLUE_ACCURACY_LEVEL_CITY
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
5 = GCLUE_ACCURACY_LEVEL_NEIGHBORHOOD
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
6 = GCLUE_ACCURACY_LEVEL_STREET
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
8 = GCLUE_ACCURACY_LEVEL_EXACT
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
gpx_tidy_points=true
.sp
ATM Only attempts to remove a suspicious first point of a GPX track (as opposed to any points within a track)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
gpx_tidy_points_max_speed=340
.sp
Over this speed (in metres per second) for the first pair of points \- the first point is removed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
layers_create_trw_auto_default=false
.sp
Create new TrackWaypoint layers without showing the layer properties dialog first\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
layers_panel_calendar_markup_mode=3
.sp
0=No markups\&. 1=Day marked\&. 2=Day marked and tooltips created\&. 3=Auto (timed tooltip creation, so if too slow it reverts to 1)\&.
.sp
If the following message is shown in the message log:\fIvik_layers_panel_calendar_update: detail level reduced as taking too long\fRthen consider setting this value to 2 \- although with the caveat that calendar refreshes may introduce noticable delays\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_cache_status_no_file_color=red
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_cache_status_expired_color=yellow
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_cache_status_download_error_color=darkred
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_cache_status_okay_color=teal
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
maps_cache_status_*_color value strings are passed directly into the low level function
\m[blue]\fBgdk_color_parse()\fR\m[]\&\s-2\u[14]\d\s+2\&.
.sp
The string can either one of a large set of standard names (taken from the X11 rgb\&.txt file), or it can be a hexadecimal value in the form "#rgb" "#rrggbb", "#rrrgggbbb" or "#rrrrggggbbbb" where \*(Aqr\*(Aq, \*(Aqg\*(Aq and \*(Aqb\*(Aq are hex digits of the red, green, and blue components of the color, respectively\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_max_tiles=1000
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_min_shrinkfactor=0\&.0312499
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_max_shrinkfactor=8\&.0000001
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_real_min_shrinkfactor=0\&.0039062499
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_scale_inc_down=4
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_scale_inc_up=2
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
maps_scale_smaller_zoom_first=true
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
modifications_ignore_visibility_toggle=false
.sp
Particularly if one often views large \&.vik files, then changing the visibility of items may be considered just part of the viewing process\&. Thus maybe you don\*(Aqt want to be notified on exit about such things \- in this case you can set this value to true\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
srtm_http_base_url=https://dds\&.cr\&.usgs\&.gov/srtm/version2_1/SRTM3
.sp
Allows using an alternative service for acquiring DEM SRTM files\&. Note that the layout on the server needs to be split into Continent directories\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mapnik_buffer_size=128 (in pixels)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
osm_basic_auth=false
.sp
Set to true to force the use of HTTP Basic Authentication even when OAuth is available
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
background_max_threads=10
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
background_max_threads_local=\fINumber of CPUs\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_default_tool=Select
.sp
Options are: Pan, Zoom, Ruler or Select
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_menubar=true
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_copy_centre_full_format=false
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_move_scroll_timeout=5 (milliseconds)
.sp
Time to wait between move scroll events before redrawing
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_zoom_scroll_timeout=150 (milliseconds)
.sp
Time to wait between zoom scroll events before redrawing
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_pinch_gesture_factor=1\&.5
.sp
Sensitivity factor for pinch zooming\&. Best to use keep this value somewhere between 0\&.5 and 3\&.0 \- a higher value is more sensitive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
window_mount_device_id=NULL
.sp
If your desktop environment doesn\*(Aqt automatically mount USB storage devices or you wish to also manage it in Viking \- then set this to a device\*(Aqs drive label e\&.g
\fIGARMIN\fR
or
\fIUUID\fR
value\&.
.sp
Viking will then put menu entries under
Help
so you can be manually perform operations as required\&.
.sp
This is provided as a very basic opt in feature, only allowing specification and management of just one device via some additional menu entries\&. Presently
\fIno\fR
intention to make this a more fully fledged feature; USB device management is left to other programs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
version_check_period_days=14
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
trackwaypoint_start_end_distance_diff=100\&.0
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
trackwaypoint_tab_default=0
.sp
Allows changing the default tab displayed when the layer property dialog is shown\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
gps_statusbar_format=GSA
.sp
This string is in the Message Format Code
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
geoclue_statusbar_format=SA
.sp
This string is in the Message Format Code
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
trkpt_selected_statusbar_format=KEATDN
.sp
This string is in the Message Format Code
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
utils_nearest_tz_factor=1\&.0
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viewport_history_size=20
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viewport_history_diff_dist=500
.sp
In metres\&.
.sp
Go Back or Go Forward requests over this range from the last history location will move back to that position\&. If within this range it will skip over this location and move on to the next saved history location\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viewport_scale=1
.sp
If Viking doesn\*(Aqt automatically detect a high resolution display, you can force the setting here \- typically by setting this to 2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
viewport_popup_delay=200
.sp
In milliseconds
.sp
Viking should show a popup with the name of the current track selected\&. If it is not shown (perhaps you have a slowish machine), try increasing this value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
external_diary_program=\m[blue]\fBrednotebook\fR\m[]\&\s-2\u[15]\d\s+2
.sp
Or in Windows it uses
C:/Progra~1/Rednotebook/rednotebook\&.exe
\- This string value must use Unix separators and not have spaces\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
external_astro_program=\m[blue]\fBstellarium\fR\m[]\&\s-2\u[16]\d\s+2
.sp
Or in Windows use
C:/Progra~1/Stellarium/stellarium\&.exe
\- This string value must use Unix separators and not have spaces\&. Needs to be version 0\&.15\&.0 or greater (otherwise due to this
\m[blue]\fBBug\fR\m[]\&\s-2\u[17]\d\s+2
means this does not actually work)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
external_text_program=gedit
.sp
Or in Windows it uses
notepad
\- This string value must use Unix separators and not have spaces\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bfilter_simplify=100
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bfilter_compress=0\&.001
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
list_date_format=%Y\-%m\-%d %H:%M
.sp
A
\m[blue]\fBdate format description\fR\m[]\&\s-2\u[18]\d\s+2
as passed on to strftime()\&. Note that when displayed in tables sorting by this column simply uses the text value, rather than the underlying date/time value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
export_device_path=OS Specific
.sp
UNIX = "/media/\fIuser\fR/GARMIN/Garmin/GPX"
.sp
WINDOWS = ":/Garmin/GPX"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
export_device_trackpoint_limit=10000 (Typical Garmin Edge limit)
.sp
Older Garmins limits are typically much lower \- Etrex 20/30 is 500
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
export_device_routepoint_limit=250
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
kmz_default_maps_dir=\fIEmpty\fR
.sp
You may want to use something like: "/media/\fIuser\fR/GARMIN/Garmin/CustomMaps"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
geotag_photo_dir="/home/\fIuser\fR/Pictures"
.sp
Override the base search location for photographs
.sp
A matching dated directory corresponding to the track is attempted of the format /geotag_photo_dir/YYYY/MM/DD
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
gpx_comment_time_format="%d\-%B\-%y %H:%M:%S"
.sp
The fallback format used in generating timestamps for waypoints from their comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
use_env_browser=false
.sp
By default Viking uses the low level function gtk_show_uri_on_window() function to open URLs, which typically results in opening a new instance of a web browser\&.
.sp
This can be overridden by setting this configuration value to true and setting the environment variable
\fBBROWSER\fR
to invoke the desired browser, optionally including command line parameters to invoke the desired behaviour; such as "firefox \-\-new\-tab"\&.
.sp
One could even have a more complicated string to run a specific version with a specific profile, e\&.g\&.
\fBBROWSER="/home/rob/Downloads/firefox/firefox \-P \*(AqNightly\*(Aq \-\-new\-tab" viking\fR
.sp
Note that if you set
\fBBROWSER\fR, other programs may also use this value\&.
.sp
This is not applicable on Windows as currently Viking uses the low level function ShellExecute() method to open URLs\&.
.RE
Message Format Code.PP
Currently for ease of implementation the message format code is a string of characters\&.
.PP
Each character represents what should be inserted in relation to a Trackpoint\&.
.PP
One day it might evolve into something more user friendly with a frontend to control it, perhaps allowing arbitrary text too\&. However for now at least some control is offered :)
.PP
.PP
Character Code
.RS 4
G = Some text to display at the start of the message \-
\fIGPSD\fR
.sp
K = Some text to display at the start of the message \-
\fITrkpt\fR
.sp
A = Altitude of a Trackpoint
.sp
S = Speed of a Trackpoint
.sp
B = Vertical Speed (Climb)
.sp
C = Course of a Trackpoint
.sp
L = Location of a Trackpoint
.sp
T = Time of a Trackpoint
.sp
M = Time diff of a Trackpoint from the previous trackpoint
.sp
X = Number of satellites used in the trackpoint fix
.sp
D = Distance of the trackpoint from the start of a track (following along the track)
.sp
F = Distance of the trackpoint from the finish (end) of a track (following along the track)
.sp
P = Distance difference of the trackpoint from the previous trackpoint
.sp
N = Name of track to which the trackpoint belongs
.sp
E = Name of the trackpoint
.RE
.PP
Output Notes
.RS 4
If the output has
\fI*\fR
after it, then the value has been calculated via interpolation (such as speed when the Trackpoint does not contain a speed value)\&.
.sp
If the output has
\fI**\fR
after it, then difficulties were encountered in trying to work out the value so probably a default of 0 will be shown\&.
.RE
Keyboard Shortcuts (Accelerator) Settings.PP
This is held in the file
keys\&.rc
in your
User Configuration File Location\&.
.PP
It is in the standard GTK Accelerator map format\&. Values are automatically read in and saved between
Viking
sessions\&.
.PP
This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired\&.
.SH "ENVIRONMENT"
.PP
\fBXDG_DATA_HOME\fR
.RS 4
Optional directory to look for extension files (maps\&.xml,
goto_tools\&.xml,
datasources\&.xml,
external_tools\&.xml,
routing\&.xml)\&.
.RE
.PP
\fBXDG_DATA_DIRS\fR
.RS 4
Path used to change the directories scanned for extension files (maps\&.xml,
goto_tools\&.xml,
datasources\&.xml,
external_tools\&.xml,
routing\&.xml)\&.
.RE
.PP
\fBVIKING_MAPS\fR
.RS 4
The path used for the default root location of maps\&.
.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 2021 Rob Norris
.br
.SH "NOTES"
.IP " 1." 4
RFC5870
.RS 4
\%https://tools.ietf.org/html/rfc5870
.RE
.IP " 2." 4
Maps Wiki
.RS 4
\%https://sourceforge.net/p/viking/wikiallura/Maps/
.RE
.IP " 3." 4
ETag
.RS 4
\%https://en.wikipedia.org/wiki/HTTP_ETag
.RE
.IP " 4." 4
Tile Map Service Specification
.RS 4
\%https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification
.RE
.IP " 5." 4
WMS Tile Caching
.RS 4
\%https://wiki.osgeo.org/wiki/WMS_Tile_Caching
.RE
.IP " 6." 4
OSRM
.RS 4
\%http://project-osrm.org/
.RE
.IP " 7." 4
Zoom Levels
.RS 4
\%https://wiki.openstreetmap.org/wiki/Zoom_levels
.RE
.IP " 8." 4
GPSBabel File Formats
.RS 4
\%https://www.gpsbabel.org/capabilities.html
.RE
.IP " 9." 4
XDG Base Directory compliant
.RS 4
\%https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
.RE
.IP "10." 4
CURLOPT_CAINFO
.RS 4
\%https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO.html
.RE
.IP "11." 4
CURLOPT_SSL_VERIFYPEER
.RS 4
\%https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html
.RE
.IP "12." 4
CURLOPT_USERAGENT
.RS 4
\%https://curl.se/libcurl/c/CURLOPT_USERAGENT.html
.RE
.IP "13." 4
GClueAccuracyLevel
.RS 4
\%https://www.freedesktop.org/software/geoclue/docs/libgeoclue/libgeoclue-gclue-enums.html#GClueAccuracyLevel
.RE
.IP "14." 4
gdk_color_parse()
.RS 4
\%https://docs.gtk.org/gdk3/type_func.Color.parse.html
.RE
.IP "15." 4
rednotebook
.RS 4
\%https://rednotebook.sourceforge.io/
.RE
.IP "16." 4
stellarium
.RS 4
\%https://stellarium.org/
.RE
.IP "17." 4
Bug
.RS 4
\%https://bugs.launchpad.net/stellarium/+bug/1410529
.RE
.IP "18." 4
date format description
.RS 4
\%https://pubs.opengroup.org/onlinepubs/007908799/xsh/strftime.html
.RE