]> git.street.me.uk Git - andy/viking.git/blame - help/viking.xml.in
projects / andy / viking.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Improve function comments as these don't return anything
[andy/viking.git] / help / viking.xml.in
CommitLineData
5c388229
GB		 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" [
4
5<!--
6
7Process this file with an XSLT processor: `xsltproc \
8-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
9manpages/docbook.xsl manpage.dbk'. A manual page
10<package>.<section> will be generated. You may view the
11manual page with: nroff -man <package>.<section> | less'. A
12typical entry in a Makefile or Makefile.am is:
13
14DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
15manpages/docbook.xsl
16XP=xsltproc -''-nonet
17
18manpage.1: manpage.dbk
19 $(XP) $(DB2MAN) $<
20
21The xsltproc binary is found in the xsltproc package. The
22XSL files are in docbook-xsl. Please remember that if you
23create the nroff version in one of the debian/rules file
24targets (such as build), you will need to include xsltproc
25and docbook-xsl in your Build-Depends control field.
26
27-->
28
29 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
30 <!ENTITY dhfirstname "<firstname>Ralf</firstname>">
31 <!ENTITY dhsurname "<surname>Meyer</surname>">
146e6a79 32 <!ENTITY dhdate "<date>@ISODATE@</date>">
6ece5489 33 <!ENTITY dhsource "Viking">
47179fe3 34 <!ENTITY dhversion "@PACKAGE_VERSION@">
5c388229
GB		 35 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
36 allowed: see man(7), man(1). -->
37 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
38 <!ENTITY dhemail "<email>ranfyy@gmail.com</email>">
39 <!ENTITY dhusername "Ralf Meyer">
40 <!ENTITY dhucpackage "<refentrytitle>VIKING</refentrytitle>">
41 <!ENTITY dhpackage "viking">
42
43 <!ENTITY debian "<productname>Debian</productname>">
44 <!ENTITY gnu "<acronym>GNU</acronym>">
45 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
46]>
47
6ece5489
RN		 48<reference>
49<title>&dhsource; &dhversion;</title>
50
1b6659bd 51<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
5c388229
GB		 52 <refentryinfo>
53 <address>
54 &dhemail;
55 </address>
56 <copyright>
57 <year>2007</year>
58 <holder>&dhusername;</holder>
59 </copyright>
e4a44c0e
GB		 60 <copyright>
61 <year>2010</year>
62 <holder>Guilhem Bonnefille</holder>
63 </copyright>
d62c5714 64 <copyright>
95272265 65 <year>2013</year>
d62c5714
RN		 66 <holder>Rob Norris</holder>
67 </copyright>
5c388229
GB		 68 &dhdate;
69 </refentryinfo>
70 <refmeta>
71 &dhucpackage;
5c388229 72 &dhsection;
6ece5489
RN		 73 <refmiscinfo CLASS="source">&dhsource;</refmiscinfo>
74 <refmiscinfo CLASS="version">&dhversion;</refmiscinfo>
5c388229
GB		 75 </refmeta>
76 <refnamediv>
77 <refname>&dhpackage;</refname>
78
79 <refpurpose>program to manage GPS data</refpurpose>
80 </refnamediv>
81 <refsynopsisdiv>
82 <cmdsynopsis>
83 <command>&dhpackage;</command>
85540d7a
GB		 84 <group choice="opt">
85 <arg choice="plain"><option>-d</option></arg>
86 <arg choice="plain"><option>--debug</option></arg>
87 </group>
88 <group choice="opt">
89 <arg choice="plain"><option>-V</option></arg>
90 <arg choice="plain"><option>--verbose</option></arg>
91 </group>
c12d4347
RN		 92 <sbr/>
93 <group choice="opt">
94 <arg choice="plain"><option>--latitude</option> <replaceable>degrees</replaceable></arg>
95 </group>
96 <group choice="opt">
97 <arg choice="plain"><option>--longitude</option> <replaceable>degrees</replaceable></arg>
98 </group>
99 <sbr/>
100 <group choice="opt">
101 <arg choice="plain"><option>-z</option></arg>
102 <arg choice="plain"><option>--zoom</option> <replaceable>ZoomLevelOSM</replaceable></arg>
103 </group>
104 <group choice="opt">
105 <arg choice="plain"><option>-m</option></arg>
106 <arg choice="plain"><option>--map</option> <replaceable>MapId</replaceable></arg>
107 </group>
108 <sbr/>
85540d7a
GB		 109 <arg rep="repeat"><replaceable>file</replaceable></arg>
110 </cmdsynopsis>
111 <cmdsynopsis>
112 <command>&dhpackage;</command>
113 <group choice="opt">
114 <arg choice="plain"><option>-h</option></arg>
115 <arg choice="plain"><option>--help</option></arg>
116 </group>
117 </cmdsynopsis>
118 <cmdsynopsis>
119 <command>&dhpackage;</command>
120 <group choice="opt">
121 <arg choice="plain"><option>-v</option></arg>
122 <arg choice="plain"><option>--version</option></arg>
123 </group>
5c388229
GB		 124 </cmdsynopsis>
125 </refsynopsisdiv>
126 <refsect1>
127 <title>DESCRIPTION</title>
128
129 <para>
d62c5714
RN		 130 Viking is a program to manage GPS data.
131 </para>
132 <para>
e5ee3c87
RN		 133 You can import and plot tracks, routes and waypoints, show OpenStreetMap (OSM) and/or other maps, generate maps (using Mapnik),
134 geotag images, add coordinate lines, make new tracks, routes and waypoints, hide different things, etc.
135 It is written mainly in C with some C++ and uses the GTK+ 2 toolkit. It is available for Linux, other POSIX operating systems and Windows.
d62c5714
RN		 136 </para>
137 <para>
138 Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
5c388229
GB		 139 </para>
140 <para>
d62c5714 141 Viking is licensed under the GNU GPL.
5c388229
GB		 142 </para>
143
5c388229
GB		 144 </refsect1>
145 <refsect1>
146 <title>OPTIONS</title>
147
148 <variablelist>
149 <varlistentry>
85540d7a 150 <term><option>file</option></term>
5c388229
GB		 151 <listitem>
152 <para>Specify file to load at start.</para>
153 </listitem>
154 </varlistentry>
85540d7a
GB		 155 <varlistentry>
156 <term><option>-d</option></term>
157 <term><option>--debug</option></term>
158 <listitem>
159 <para>Enable debug output.</para>
160 </listitem>
161 </varlistentry>
162 <varlistentry>
163 <term><option>-V</option></term>
164 <term><option>--verbose</option></term>
165 <listitem>
166 <para>Enable verbose output.</para>
167 </listitem>
168 </varlistentry>
169 <varlistentry>
170 <term><option>-?</option></term>
171 <term><option>--help</option></term>
172 <listitem>
173 <para>Show help options.</para>
174 </listitem>
175 </varlistentry>
176 <varlistentry>
177 <term><option>-v</option></term>
178 <term><option>--version</option></term>
179 <listitem>
180 <para>Show version.</para>
181 </listitem>
182 </varlistentry>
c12d4347
RN		 183 <varlistentry>
184 <term><option>--latitude</option></term>
185 <listitem>
186 <para>Set the initial position to the specified latitude in decimal degrees.</para>
187 </listitem>
188 </varlistentry>
189 <varlistentry>
190 <term><option>--longitude</option></term>
191 <listitem>
192 <para>Set the initial position to the specified longitude in decimal degrees.</para>
193 </listitem>
194 </varlistentry>
195 <varlistentry>
196 <term><option>-z</option></term>
197 <term><option>--zoom</option></term>
198 <listitem>
199 <para>Set the initial zoom level. The value is the OSM zoom level (0 - 22).</para>
200 </listitem>
201 </varlistentry>
202 <varlistentry>
203 <term><option>-m</option></term>
204 <term><option>--map</option></term>
205 <listitem>
206 <para>Add a map layer by specifying the map id. The value needs to match one of the internal ids or an id from the maps configuration extension (see below).
207 Specifying a value of 0 will use the configured map layer default.</para>
208<variablelist>
3656598f
RN		 209 <varlistentry><term></term><listitem><para>Internal Map Ids:</para></listitem></varlistentry>
210 <varlistentry><term></term><listitem><para>OSM Mapnik = 13</para></listitem></varlistentry>
211 <varlistentry><term></term><listitem><para>OSM Cycle = 17</para></listitem></varlistentry>
212 <varlistentry><term></term><listitem><para>Mapquest OSM = 19</para></listitem></varlistentry>
c12d4347
RN		 213</variablelist>
214 </listitem>
215 </varlistentry>
5c388229
GB		 216 </variablelist>
217
e4a44c0e
GB		 218 </refsect1>
219 <refsect1>
220 <title>Extending Viking</title>
221
357c069e 222 <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>
e4a44c0e
GB		 223 <para>Here is an example:
224<literallayout><![CDATA[
225<objects>
226 <object class="ClassName">
227 <property name="property_name1">Property value</property>
228 <property name="property_name2">Property value</property>
229 </object>
230 ...
231<objects>
232]]>
233</literallayout>
234</para>
235 <para>You can find more examples in the documentation part of the distribution.</para>
236 <formalpara>
237 <title>Map Source</title>
238 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
239 <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
90f15672 240 <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
e4a44c0e
GB		 241 <variablelist>
242 <varlistentry>
243 <term>id</term>
244 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
245 </varlistentry>
2eb18edc
RN		 246 <varlistentry>
247 <term>name</term>
248 <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>
249 </varlistentry>
e4a44c0e
GB		 250 <varlistentry>
251 <term>label</term>
252 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
253 </varlistentry>
254 <varlistentry>
255 <term>hostname</term>
256 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
1b6659bd
GB		 257 </varlistentry>
258 <varlistentry>
259 <term>url</term>
dbd63864
RN		 260 <listitem>
261 <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>
262 <note>
263 <para>The full parametrized address can just be put in the URL field and the hostname field doesn't need specifying.</para>
264 <para>e.g. "https://tile.openstreetmap.org/%d/%d/%d.png"</para>
265 </note>
266 </listitem>
413e9753 267 </varlistentry>
e633ddef
RN		 268 <varlistentry>
269 <term>zoom-min (optional)</term>
270 <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
271 </varlistentry>
272 <varlistentry>
273 <term>zoom-max (optional)</term>
274 <listitem>
275 <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
276 <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
277 </listitem>
278 </varlistentry>
2113a507
RN		 279 <varlistentry>
280 <term>lat-min (optional)</term>
281 <listitem><para>The minimum latitude value in degrees supported by the tile server. The Default is -90 degrees if not specified.</para></listitem>
282 </varlistentry>
283 <varlistentry>
284 <term>lat-max (optional)</term>
285 <listitem><para>The maximum latitude value in degrees supported by the tile server. The Default is 90 degrees if not specified.</para></listitem>
286 </varlistentry>
287 <varlistentry>
288 <term>lon-min (optional)</term>
289 <listitem><para>The minimum longitude value in degrees supported by the tile server. The Default is -180 degrees if not specified.</para></listitem>
290 </varlistentry>
291 <varlistentry>
292 <term>lon-max (optional)</term>
293 <listitem><para>The maximum longitude value in degrees supported by the tile server. The Default is 180 degrees if not specified.</para></listitem>
294 </varlistentry>
14b57d17
RN		 295 <varlistentry>
296 <term>file-extension (optional)</term>
297 <listitem>
298 <para>The file extension of the files on disk. The default is <emphasis>.png</emphasis></para>
299 <para>If the tile source URL ends in something other than .png, then this parameter will need to match it.</para>
300 <para>This can also be useful in reading a tileset from other software which may name tiles in an alternative form,
301 e.g. for Mobile Atlas creator it names them <emphasis>.png.tile</emphasis></para>
302 <note><para>The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG.</para></note>
303 <note><para>Remember to include the beginning <emphasis>'.'</emphasis> when specifying this parameter.</para></note>
304 </listitem>
305 </varlistentry>
413e9753
RN		 306 <varlistentry>
307 <term>switch-xy (optional)</term>
f2e8376a
RN		 308 <listitem>
309 <para>Swap the X,Y values around in the URL parametrized ordering.</para>
310 <para>The default is false.</para>
311 </listitem>
312 </varlistentry>
313 <varlistentry>
314 <term>check-file-server-time (optional)</term>
315 <listitem>
316 <para>Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not.</para>
317 <para>The default is false.</para>
318 </listitem>
319 </varlistentry>
320 <varlistentry>
321 <term>use-etag (optional)</term>
322 <listitem>
323 <para>Use and compare the <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink> value in determining whether to download a newer tile. The default is false.</para>
324 <para>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.</para>
325 </listitem>
1b6659bd
GB		 326 </varlistentry>
327 </variablelist>
328 </para>
f2e8376a 329 <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties (as per VikSlippyMapSource above):
1b6659bd
GB		 330 <variablelist>
331 <varlistentry>
332 <term>id</term>
1b6659bd
GB		 333 </varlistentry>
334 <varlistentry>
335 <term>label</term>
1b6659bd
GB		 336 </varlistentry>
337 <varlistentry>
338 <term>hostname</term>
e4a44c0e
GB		 339 </varlistentry>
340 <varlistentry>
341 <term>url</term>
f2e8376a
RN		 342 </varlistentry>
343 <varlistentry>
344 <term>check-file-server-time (optional)</term>
e4a44c0e 345 </varlistentry>
abc19988
RN		 346 <varlistentry>
347 <term>zoom-min (optional)</term>
348 </varlistentry>
349 <varlistentry>
350 <term>zoom-max (optional)</term>
351 </varlistentry>
352 <varlistentry>
353 <term>lat-min (optional)</term>
354 </varlistentry>
355 <varlistentry>
356 <term>lat-max (optional)</term>
357 </varlistentry>
358 <varlistentry>
359 <term>lon-min (optional)</term>
360 </varlistentry>
361 <varlistentry>
362 <term>lon-max (optional)</term>
363 </varlistentry>
e4a44c0e
GB		 364 </variablelist>
365 </para>
f2e8376a 366 <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties (as per VikSlippyMapSource above):
90f15672
GB		 367 <variablelist>
368 <varlistentry>
369 <term>id</term>
90f15672
GB		 370 </varlistentry>
371 <varlistentry>
372 <term>label</term>
90f15672
GB		 373 </varlistentry>
374 <varlistentry>
375 <term>hostname</term>
90f15672
GB		 376 </varlistentry>
377 <varlistentry>
378 <term>url</term>
f2e8376a
RN		 379 </varlistentry>
380 <varlistentry>
381 <term>check-file-server-time (optional)</term>
90f15672 382 </varlistentry>
abc19988
RN		 383 <varlistentry>
384 <term>zoom-min (optional)</term>
385 </varlistentry>
386 <varlistentry>
387 <term>zoom-max (optional)</term>
388 </varlistentry>
389 <varlistentry>
390 <term>lat-min (optional)</term>
391 </varlistentry>
392 <varlistentry>
393 <term>lat-max (optional)</term>
394 </varlistentry>
395 <varlistentry>
396 <term>lon-min (optional)</term>
397 </varlistentry>
398 <varlistentry>
399 <term>lon-max (optional)</term>
400 </varlistentry>
90f15672
GB		 401 </variablelist>
402 </para>
e4a44c0e
GB		 403 </formalpara>
404
405 <formalpara>
406 <title>Go-to search engines</title>
407 <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>
408 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
409 <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>
410 <para>The related properties are:
411 <variablelist>
412 <varlistentry>
413 <term>label</term>
414 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
415 </varlistentry>
416 <varlistentry>
417 <term>url-format</term>
418 <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>
419 </varlistentry>
420 <varlistentry>
421 <term>lat-path</term>
422 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
423 </varlistentry>
424 <varlistentry>
425 <term>lat-attr (optional)</term>
426 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
427 </varlistentry>
428 <varlistentry>
429 <term>lon-path</term>
430 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
431 </varlistentry>
432 <varlistentry>
433 <term>lon-attr (optional)</term>
434 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
435 </varlistentry>
436 </variablelist>
437 </para>
438 <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>
439 </formalpara>
440
441 <formalpara>
442 <title>External tools</title>
443 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
444 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
3bdd680c 445 <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
e4a44c0e
GB		 446 <para>The related properties are:
447 <variablelist>
e4a44c0e
GB		 448 <varlistentry>
449 <term>label</term>
450 <listitem><para>the text displayed in the menu entry</para></listitem>
451 </varlistentry>
452 <varlistentry>
453 <term>url</term>
3bdd680c
GB		 454 <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&amp;lon=%s&amp;zoom=%d")</para></listitem>
455 </varlistentry>
456 </variablelist>
457 </para>
458 <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
459 <para>The related properties are:
460 <variablelist>
461 <varlistentry>
95272265
RN		 462 <term>label</term>
463 <listitem><para>the text displayed in the menu entry</para></listitem>
3bdd680c 464 </varlistentry>
95272265
RN		 465 <varlistentry>
466 <term>url</term>
467 <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&amp;right=%s&amp;bottom=%s&amp;top=%s")</para></listitem>
468 </varlistentry>
469 </variablelist>
470 </para>
471 </formalpara>
472
473 <formalpara>
474 <title>Remote File Datasources</title>
475 <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
476 <para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
477 <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
478 <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para>
479 <para>The related properties are:
480 <variablelist>
3bdd680c
GB		 481 <varlistentry>
482 <term>label</term>
483 <listitem><para>the text displayed in the menu entry</para></listitem>
484 </varlistentry>
485 <varlistentry>
486 <term>url</term>
95272265
RN		 487 <listitem>
488 <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&amp;lon=%s</literal></para>
489 <para>The order and meaning of these parameters is given by the url_format_code below</para>
490 </listitem>
491 </varlistentry>
492 <varlistentry>
493 <term>url_format_code</term>
494 <listitem>
495 <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para>
496 <para>B = Bottom of the current view i.e. minimum latitude</para>
497 <para>L = Left of the current view i.e. minimum longitude</para>
498 <para>T = Top of the current view i.e. maximum latitude</para>
499 <para>R = Right of the current view i.e. maximum longitude</para>
500 <para>A = center lAtitude of the current view</para>
501 <para>O = center lOngitude of the current view</para>
502 <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
d66e24e1 503 <para>S = A user specified input string requested from the user via a dialog box</para>
95272265
RN		 504 <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
505 </listitem>
506 </varlistentry>
507 <varlistentry>
508 <term>file_type</term>
509 <listitem>
510 <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
511 <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
512 <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>
513 </listitem>
e4a44c0e 514 </varlistentry>
d66e24e1
MH		 515 <varlistentry>
516 <term>babel_filter_args</term>
517 <listitem>
518 <para>This value is passed on for the filter arguments interfacing with GPSBabel.</para>
519 <para>E.g. "-x nuketypes,routes" can be used to filter all routes from the results.</para>
520 </listitem>
521 </varlistentry>
522 <varlistentry>
523 <term>input_label</term>
524 <listitem>
525 <para>This value is used when requesting input from the user.</para>
526 <para>It is the label of the text input box.</para>
527 </listitem>
528 </varlistentry>
e4a44c0e
GB		 529 </variablelist>
530 </para>
531 </formalpara>
532
533 </refsect1>
534 <refsect1>
535 <title>FILES</title>
536
537 <variablelist>
538 <varlistentry>
539 <term><filename>~/.viking/maps.xml</filename></term>
540 <listitem>
541 <para>File containing definition of map sources.</para>
542 <para>See previous section for details.</para>
543 </listitem>
544 </varlistentry>
b2709f5e
GB		 545 <varlistentry>
546 <term><filename>~/.viking/goto_tools.xml</filename></term>
547 <listitem>
548 <para>File containing definition of "Go-to" services.</para>
549 <para>See previous section for details.</para>
550 </listitem>
551 </varlistentry>
552 <varlistentry>
553 <term><filename>~/.viking/external_tools.xml</filename></term>
554 <listitem>
555 <para>File containing definition of external tools.</para>
556 <para>See previous section for details.</para>
557 </listitem>
558 </varlistentry>
95272265
RN		 559 <varlistentry>
560 <term><filename>~/.viking/datasources.xml</filename></term>
561 <listitem>
562 <para>File containing definition of remote file datasources.</para>
563 <para>See previous section for details.</para>
564 </listitem>
565 </varlistentry>
b2709f5e
GB		 566 <varlistentry>
567 <term><filename>~/.viking/viking.prefs</filename></term>
568 <listitem>
569 <para>Preferences for &dhpackage;.</para>
570 </listitem>
571 </varlistentry>
2ed09ddf
RN		 572 <varlistentry>
573 <term><filename>~/.viking/viking_layer_defaults.ini</filename></term>
574 <listitem>
575 <para>Layer default values for &dhpackage;.</para>
576 </listitem>
577 </varlistentry>
78609471
RN		 578 <varlistentry>
579 <term><filename>~/.viking/viking.ini</filename></term>
580 <listitem>
581 <para>Values for &dhpackage; automatically saved between sessions.</para>
582 <para>Not generally intended to be manually edited.</para>
583 <para>However some finer control of default internal values can be set.</para>
584 </listitem>
585 </varlistentry>
7b97b14c
RN		 586 <varlistentry>
587 <term><filename>~/.viking/keys.rc</filename></term>
588 <listitem>
589 <para>File containing short cut key accelerators.</para>
590 <para>This is in the standard GTK Accelerator map format.</para>
591 </listitem>
592 </varlistentry>
e4a44c0e
GB		 593 <varlistentry>
594 <term><filename>~/.viking/cookies.txt</filename></term>
595 <listitem>
596 <para>File hosting cookies used by &dhpackage;.</para>
e4a44c0e
GB		 597 </listitem>
598 </varlistentry>
599 <varlistentry>
600 <term><filename>~/.viking-maps/</filename></term>
601 <listitem>
e5ee3c87 602 <para>Default location of the map cache of tiles downloaded or created by &dhpackage;.</para>
e4a44c0e
GB		 603 </listitem>
604 </varlistentry>
605 </variablelist>
606
29f1598c
GB		 607 <para>Extension files (<filename>maps.xml</filename>,
608 <filename>goto_tools.xml</filename>,
95272265 609 <filename>datasources.xml</filename>,
29f1598c
GB		 610 <filename>external_tools.xml</filename>)
611 are also searched in <filename>/etc/viking</filename> and
612 <filename>/usr/share/viking</filename> directories (or related in your system).</para>
613
614 </refsect1>
615 <refsect1>
616 <title>ENVIRONMENT</title>
617
618 <variablelist>
619 <varlistentry>
620 <term><envar>XDG_DATA_HOME</envar></term>
621 <listitem>
622 <para>Optional directory to look for extension files
623 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
624 <filename>external_tools.xml</filename>).</para>
625 </listitem>
626 </varlistentry>
627 <varlistentry>
628 <term><envar>XDG_DATA_DIRS</envar></term>
629 <listitem>
630 <para>Path used to change the directories scanned for extension files
631 (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
632 <filename>external_tools.xml</filename>).</para>
633 </listitem>
634 </varlistentry>
635 </variablelist>
636
5c388229 637 </refsect1>
5c388229
GB		 638 <refsect1>
639 <title>AUTHOR</title>
640
d62c5714 641 <para>This manual page was originally written by &dhusername; &dhemail; for
5c388229
GB		 642 the &debian; system (but may be used by others). Permission is
643 granted to copy, distribute and/or modify this document under
644 the terms of the &gnu; General Public License, Version 2 any
645 later version published by the Free Software Foundation.
646 </para>
647 <para>
648 On Debian systems, the complete text of the GNU General Public
649 License can be found in /usr/share/common-licenses/GPL.
650 </para>
651
652 </refsect1>
653</refentry>
6ece5489 654</reference>
Viking GPS editor