]>
Commit | Line | Data |
---|---|---|
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 | ||
7 | Process this file with an XSLT processor: `xsltproc \ | |
8 | -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\ | |
9 | manpages/docbook.xsl manpage.dbk'. A manual page | |
10 | <package>.<section> will be generated. You may view the | |
11 | manual page with: nroff -man <package>.<section> | less'. A | |
12 | typical entry in a Makefile or Makefile.am is: | |
13 | ||
14 | DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\ | |
15 | manpages/docbook.xsl | |
16 | XP=xsltproc -''-nonet | |
17 | ||
18 | manpage.1: manpage.dbk | |
19 | $(XP) $(DB2MAN) $< | |
20 | ||
21 | The xsltproc binary is found in the xsltproc package. The | |
22 | XSL files are in docbook-xsl. Please remember that if you | |
23 | create the nroff version in one of the debian/rules file | |
24 | targets (such as build), you will need to include xsltproc | |
25 | and 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. --> | |
dea58a74 | 33 | <!ENTITY dhdate "<date>2013-04-08</date>"> |
6ece5489 RN |
34 | <!-- Would be nice if the version could auto-update. --> |
35 | <!ENTITY dhsource "Viking"> | |
dea58a74 | 36 | <!ENTITY dhversion "1.4.1"> |
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> | |
94 | <arg rep="repeat"><replaceable>file</replaceable></arg> | |
95 | </cmdsynopsis> | |
96 | <cmdsynopsis> | |
97 | <command>&dhpackage;</command> | |
98 | <group choice="opt"> | |
99 | <arg choice="plain"><option>-h</option></arg> | |
100 | <arg choice="plain"><option>--help</option></arg> | |
101 | </group> | |
102 | </cmdsynopsis> | |
103 | <cmdsynopsis> | |
104 | <command>&dhpackage;</command> | |
105 | <group choice="opt"> | |
106 | <arg choice="plain"><option>-v</option></arg> | |
107 | <arg choice="plain"><option>--version</option></arg> | |
108 | </group> | |
5c388229 GB |
109 | </cmdsynopsis> |
110 | </refsynopsisdiv> | |
111 | <refsect1> | |
112 | <title>DESCRIPTION</title> | |
113 | ||
114 | <para> | |
d62c5714 RN |
115 | Viking is a program to manage GPS data. |
116 | </para> | |
117 | <para> | |
118 | You can import and plot tracks, routes and waypoints, show OpenStreetMap (OSM) maps and/or | |
119 | Terraserver maps under it, add coordinate lines, make new tracks, routes and waypoints, hide different things, etc. | |
120 | It is written in C with the GTK+ 2 toolkit, available for Linux, other POSIX operating systems and Windows. | |
121 | </para> | |
122 | <para> | |
123 | Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink> | |
5c388229 GB |
124 | </para> |
125 | <para> | |
d62c5714 | 126 | Viking is licensed under the GNU GPL. |
5c388229 GB |
127 | </para> |
128 | ||
5c388229 GB |
129 | </refsect1> |
130 | <refsect1> | |
131 | <title>OPTIONS</title> | |
132 | ||
133 | <variablelist> | |
134 | <varlistentry> | |
85540d7a | 135 | <term><option>file</option></term> |
5c388229 GB |
136 | <listitem> |
137 | <para>Specify file to load at start.</para> | |
138 | </listitem> | |
139 | </varlistentry> | |
85540d7a GB |
140 | <varlistentry> |
141 | <term><option>-d</option></term> | |
142 | <term><option>--debug</option></term> | |
143 | <listitem> | |
144 | <para>Enable debug output.</para> | |
145 | </listitem> | |
146 | </varlistentry> | |
147 | <varlistentry> | |
148 | <term><option>-V</option></term> | |
149 | <term><option>--verbose</option></term> | |
150 | <listitem> | |
151 | <para>Enable verbose output.</para> | |
152 | </listitem> | |
153 | </varlistentry> | |
154 | <varlistentry> | |
155 | <term><option>-?</option></term> | |
156 | <term><option>--help</option></term> | |
157 | <listitem> | |
158 | <para>Show help options.</para> | |
159 | </listitem> | |
160 | </varlistentry> | |
161 | <varlistentry> | |
162 | <term><option>-v</option></term> | |
163 | <term><option>--version</option></term> | |
164 | <listitem> | |
165 | <para>Show version.</para> | |
166 | </listitem> | |
167 | </varlistentry> | |
5c388229 GB |
168 | </variablelist> |
169 | ||
e4a44c0e GB |
170 | </refsect1> |
171 | <refsect1> | |
172 | <title>Extending Viking</title> | |
173 | ||
174 | <para>Currently, &dhpackage; has some extention points based on configuration files. The file format is heavily inspired by the GtkBuilder file format: you specify the class of the GObject to build and set its properties. Technically, it is a XML file containing a "objects" root element. Inside this element, you set a collection of "object".</para> | |
175 | <para>Here is an example: | |
176 | <literallayout><![CDATA[ | |
177 | <objects> | |
178 | <object class="ClassName"> | |
179 | <property name="property_name1">Property value</property> | |
180 | <property name="property_name2">Property value</property> | |
181 | </object> | |
182 | ... | |
183 | <objects> | |
184 | ]]> | |
185 | </literallayout> | |
186 | </para> | |
187 | <para>You can find more examples in the documentation part of the distribution.</para> | |
188 | <formalpara> | |
189 | <title>Map Source</title> | |
190 | <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para> | |
191 | <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para> | |
90f15672 | 192 | <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties: |
e4a44c0e GB |
193 | <variablelist> |
194 | <varlistentry> | |
195 | <term>id</term> | |
196 | <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem> | |
197 | </varlistentry> | |
198 | <varlistentry> | |
199 | <term>label</term> | |
200 | <listitem><para>the text displayed in the map's source selection dialog</para></listitem> | |
201 | </varlistentry> | |
202 | <varlistentry> | |
203 | <term>hostname</term> | |
204 | <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem> | |
1b6659bd GB |
205 | </varlistentry> |
206 | <varlistentry> | |
207 | <term>url</term> | |
208 | <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem> | |
209 | </varlistentry> | |
210 | </variablelist> | |
211 | </para> | |
212 | <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties: | |
213 | <variablelist> | |
214 | <varlistentry> | |
215 | <term>id</term> | |
216 | <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem> | |
217 | </varlistentry> | |
218 | <varlistentry> | |
219 | <term>label</term> | |
220 | <listitem><para>the text displayed in the map's source selection dialog</para></listitem> | |
221 | </varlistentry> | |
222 | <varlistentry> | |
223 | <term>hostname</term> | |
224 | <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem> | |
e4a44c0e GB |
225 | </varlistentry> |
226 | <varlistentry> | |
227 | <term>url</term> | |
228 | <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem> | |
229 | </varlistentry> | |
230 | </variablelist> | |
231 | </para> | |
90f15672 GB |
232 | <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties: |
233 | <variablelist> | |
234 | <varlistentry> | |
235 | <term>id</term> | |
236 | <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem> | |
237 | </varlistentry> | |
238 | <varlistentry> | |
239 | <term>label</term> | |
240 | <listitem><para>the text displayed in the map's source selection dialog</para></listitem> | |
241 | </varlistentry> | |
242 | <varlistentry> | |
243 | <term>hostname</term> | |
244 | <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem> | |
245 | </varlistentry> | |
246 | <varlistentry> | |
247 | <term>url</term> | |
248 | <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem> | |
249 | </varlistentry> | |
250 | </variablelist> | |
251 | </para> | |
e4a44c0e GB |
252 | </formalpara> |
253 | ||
254 | <formalpara> | |
255 | <title>Go-to search engines</title> | |
256 | <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> | |
257 | <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para> | |
258 | <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> | |
259 | <para>The related properties are: | |
260 | <variablelist> | |
261 | <varlistentry> | |
262 | <term>label</term> | |
263 | <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem> | |
264 | </varlistentry> | |
265 | <varlistentry> | |
266 | <term>url-format</term> | |
267 | <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> | |
268 | </varlistentry> | |
269 | <varlistentry> | |
270 | <term>lat-path</term> | |
271 | <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem> | |
272 | </varlistentry> | |
273 | <varlistentry> | |
274 | <term>lat-attr (optional)</term> | |
275 | <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem> | |
276 | </varlistentry> | |
277 | <varlistentry> | |
278 | <term>lon-path</term> | |
279 | <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem> | |
280 | </varlistentry> | |
281 | <varlistentry> | |
282 | <term>lon-attr (optional)</term> | |
283 | <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem> | |
284 | </varlistentry> | |
285 | </variablelist> | |
286 | </para> | |
287 | <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> | |
288 | </formalpara> | |
289 | ||
290 | <formalpara> | |
291 | <title>External tools</title> | |
292 | <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para> | |
293 | <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para> | |
3bdd680c | 294 | <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para> |
e4a44c0e GB |
295 | <para>The related properties are: |
296 | <variablelist> | |
e4a44c0e GB |
297 | <varlistentry> |
298 | <term>label</term> | |
299 | <listitem><para>the text displayed in the menu entry</para></listitem> | |
300 | </varlistentry> | |
301 | <varlistentry> | |
302 | <term>url</term> | |
3bdd680c GB |
303 | <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&lon=%s&zoom=%d")</para></listitem> |
304 | </varlistentry> | |
305 | </variablelist> | |
306 | </para> | |
307 | <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para> | |
308 | <para>The related properties are: | |
309 | <variablelist> | |
310 | <varlistentry> | |
95272265 RN |
311 | <term>label</term> |
312 | <listitem><para>the text displayed in the menu entry</para></listitem> | |
3bdd680c | 313 | </varlistentry> |
95272265 RN |
314 | <varlistentry> |
315 | <term>url</term> | |
316 | <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&right=%s&bottom=%s&top=%s")</para></listitem> | |
317 | </varlistentry> | |
318 | </variablelist> | |
319 | </para> | |
320 | </formalpara> | |
321 | ||
322 | <formalpara> | |
323 | <title>Remote File Datasources</title> | |
324 | <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para> | |
325 | <para>The file is <filename>~/.viking/datasources.xml</filename>.</para> | |
326 | <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para> | |
327 | <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para> | |
328 | <para>The related properties are: | |
329 | <variablelist> | |
3bdd680c GB |
330 | <varlistentry> |
331 | <term>label</term> | |
332 | <listitem><para>the text displayed in the menu entry</para></listitem> | |
333 | </varlistentry> | |
334 | <varlistentry> | |
335 | <term>url</term> | |
95272265 RN |
336 | <listitem> |
337 | <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&lon=%s</literal></para> | |
338 | <para>The order and meaning of these parameters is given by the url_format_code below</para> | |
339 | </listitem> | |
340 | </varlistentry> | |
341 | <varlistentry> | |
342 | <term>url_format_code</term> | |
343 | <listitem> | |
344 | <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para> | |
345 | <para>B = Bottom of the current view i.e. minimum latitude</para> | |
346 | <para>L = Left of the current view i.e. minimum longitude</para> | |
347 | <para>T = Top of the current view i.e. maximum latitude</para> | |
348 | <para>R = Right of the current view i.e. maximum longitude</para> | |
349 | <para>A = center lAtitude of the current view</para> | |
350 | <para>O = center lOngitude of the current view</para> | |
351 | <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para> | |
352 | <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para> | |
353 | </listitem> | |
354 | </varlistentry> | |
355 | <varlistentry> | |
356 | <term>file_type</term> | |
357 | <listitem> | |
358 | <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para> | |
359 | <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para> | |
360 | <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> | |
361 | </listitem> | |
e4a44c0e GB |
362 | </varlistentry> |
363 | </variablelist> | |
364 | </para> | |
365 | </formalpara> | |
366 | ||
367 | </refsect1> | |
368 | <refsect1> | |
369 | <title>FILES</title> | |
370 | ||
371 | <variablelist> | |
372 | <varlistentry> | |
373 | <term><filename>~/.viking/maps.xml</filename></term> | |
374 | <listitem> | |
375 | <para>File containing definition of map sources.</para> | |
376 | <para>See previous section for details.</para> | |
377 | </listitem> | |
378 | </varlistentry> | |
b2709f5e GB |
379 | <varlistentry> |
380 | <term><filename>~/.viking/goto_tools.xml</filename></term> | |
381 | <listitem> | |
382 | <para>File containing definition of "Go-to" services.</para> | |
383 | <para>See previous section for details.</para> | |
384 | </listitem> | |
385 | </varlistentry> | |
386 | <varlistentry> | |
387 | <term><filename>~/.viking/external_tools.xml</filename></term> | |
388 | <listitem> | |
389 | <para>File containing definition of external tools.</para> | |
390 | <para>See previous section for details.</para> | |
391 | </listitem> | |
392 | </varlistentry> | |
95272265 RN |
393 | <varlistentry> |
394 | <term><filename>~/.viking/datasources.xml</filename></term> | |
395 | <listitem> | |
396 | <para>File containing definition of remote file datasources.</para> | |
397 | <para>See previous section for details.</para> | |
398 | </listitem> | |
399 | </varlistentry> | |
b2709f5e GB |
400 | <varlistentry> |
401 | <term><filename>~/.viking/viking.prefs</filename></term> | |
402 | <listitem> | |
403 | <para>Preferences for &dhpackage;.</para> | |
404 | </listitem> | |
405 | </varlistentry> | |
2ed09ddf RN |
406 | <varlistentry> |
407 | <term><filename>~/.viking/viking_layer_defaults.ini</filename></term> | |
408 | <listitem> | |
409 | <para>Layer default values for &dhpackage;.</para> | |
410 | </listitem> | |
411 | </varlistentry> | |
78609471 RN |
412 | <varlistentry> |
413 | <term><filename>~/.viking/viking.ini</filename></term> | |
414 | <listitem> | |
415 | <para>Values for &dhpackage; automatically saved between sessions.</para> | |
416 | <para>Not generally intended to be manually edited.</para> | |
417 | <para>However some finer control of default internal values can be set.</para> | |
418 | </listitem> | |
419 | </varlistentry> | |
e4a44c0e GB |
420 | <varlistentry> |
421 | <term><filename>~/.viking/cookies.txt</filename></term> | |
422 | <listitem> | |
423 | <para>File hosting cookies used by &dhpackage;.</para> | |
e4a44c0e GB |
424 | </listitem> |
425 | </varlistentry> | |
426 | <varlistentry> | |
427 | <term><filename>~/.viking-maps/</filename></term> | |
428 | <listitem> | |
429 | <para>Map cache of tiles downloaded by &dhpackage;.</para> | |
e4a44c0e GB |
430 | </listitem> |
431 | </varlistentry> | |
432 | </variablelist> | |
433 | ||
29f1598c GB |
434 | <para>Extension files (<filename>maps.xml</filename>, |
435 | <filename>goto_tools.xml</filename>, | |
95272265 | 436 | <filename>datasources.xml</filename>, |
29f1598c GB |
437 | <filename>external_tools.xml</filename>) |
438 | are also searched in <filename>/etc/viking</filename> and | |
439 | <filename>/usr/share/viking</filename> directories (or related in your system).</para> | |
440 | ||
441 | </refsect1> | |
442 | <refsect1> | |
443 | <title>ENVIRONMENT</title> | |
444 | ||
445 | <variablelist> | |
446 | <varlistentry> | |
447 | <term><envar>XDG_DATA_HOME</envar></term> | |
448 | <listitem> | |
449 | <para>Optional directory to look for extension files | |
450 | (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>, | |
451 | <filename>external_tools.xml</filename>).</para> | |
452 | </listitem> | |
453 | </varlistentry> | |
454 | <varlistentry> | |
455 | <term><envar>XDG_DATA_DIRS</envar></term> | |
456 | <listitem> | |
457 | <para>Path used to change the directories scanned for extension files | |
458 | (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>, | |
459 | <filename>external_tools.xml</filename>).</para> | |
460 | </listitem> | |
461 | </varlistentry> | |
462 | </variablelist> | |
463 | ||
5c388229 | 464 | </refsect1> |
5c388229 GB |
465 | <refsect1> |
466 | <title>AUTHOR</title> | |
467 | ||
d62c5714 | 468 | <para>This manual page was originally written by &dhusername; &dhemail; for |
5c388229 GB |
469 | the &debian; system (but may be used by others). Permission is |
470 | granted to copy, distribute and/or modify this document under | |
471 | the terms of the &gnu; General Public License, Version 2 any | |
472 | later version published by the Free Software Foundation. | |
473 | </para> | |
474 | <para> | |
475 | On Debian systems, the complete text of the GNU General Public | |
476 | License can be found in /usr/share/common-licenses/GPL. | |
477 | </para> | |
478 | ||
479 | </refsect1> | |
480 | </refentry> | |
6ece5489 | 481 | </reference> |