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