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