Prevent potential infinite speeds in interpolating time function.

[andy/viking.git] / help / C / commandline.xml

diff --git a/help/C/commandline.xml b/help/C/commandline.xml
index 2f1cdf2af9a92765060986889e789bfec01463ed..d528b1bb546bba894d8055fba66a958e6cb7ab9d 100644 (file)
--- a/help/C/commandline.xml
+++ b/help/C/commandline.xml
@@ -1,7 +1,10 @@
 <?xml version="1.0"?>
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
-   [<!ENTITY appname          "Viking">]
+   [
+    <!ENTITY appname          "Viking">
+    <!ENTITY dhpackage        "viking">
+   ]
 >
 <section id="commandline">
 <title>Command Line</title>
@@ -9,9 +12,52 @@
 &appname; being a Graphical User Interface program only has a few command line options.
 </para>
 
-<para>
-<screen>viking [OPTIONS...] files+</screen>
-</para>
+<!-- keep this cmdsynopsis aligned with the man page version -->
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <group choice="opt">
+        <arg choice="plain"><option>-d</option></arg>
+        <arg choice="plain"><option>--debug</option></arg>
+      </group>
+      <group choice="opt">
+        <arg choice="plain"><option>-V</option></arg>
+        <arg choice="plain"><option>--verbose</option></arg>
+      </group>
+      <sbr/>
+      <group choice="opt">
+        <arg choice="plain"><option>--latitude</option> <replaceable>degrees</replaceable></arg>
+      </group>
+      <group choice="opt">
+        <arg choice="plain"><option>--longitude</option> <replaceable>degrees</replaceable></arg>
+      </group>
+      <sbr/>
+      <group choice="opt">
+        <arg choice="plain"><option>-z</option></arg>
+        <arg choice="plain"><option>--zoom</option> <replaceable>ZoomLevelOSM</replaceable></arg>
+      </group>
+      <group choice="opt">
+        <arg choice="plain"><option>-m</option></arg>
+        <arg choice="plain"><option>--map</option> <replaceable>MapId</replaceable></arg>
+      </group>
+      <sbr/>
+      <arg rep="repeat"><replaceable>file</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <group choice="opt">
+        <arg choice="plain"><option>-h</option></arg>
+        <arg choice="plain"><option>--help</option></arg>
+      </group>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <group choice="opt">
+        <arg choice="plain"><option>-v</option></arg>
+        <arg choice="plain"><option>--version</option></arg>
+      </group>
+    </cmdsynopsis>
+  </refsynopsisdiv>
 
 <para>
 Note that the ordering of files can be important depending on their file type.
@@ -57,10 +103,46 @@ This also enables some extra information features in the GUI itself, primarily o
   <entry>--version</entry>
   <entry>Show the version and then exit.</entry>
 </row>
+<row>
+  <entry>N/A</entry>
+  <entry>--latitude</entry>
+  <entry>Set the initial position to the specified latitude in decimal degrees.</entry>
+</row>
+<row>
+  <entry>N/A</entry>
+  <entry>--longitude</entry>
+  <entry>Set the initial position to the specified longitude in decimal degrees.</entry>
+</row>
+<row>
+  <entry>-z</entry>
+  <entry>--zoom</entry>
+  <entry>Set the initial zoom level. The value is the OSM zoom level (0 - 22).</entry>
+</row>
+<row>
+  <entry>-m</entry>
+  <entry>--map</entry>
+  <entry>Add a map layer by specifying the map id. The value needs to match one of the internal ids or an id from the <xref linkend="map_source"/>.
+   Specifying a value of 0 will use the configured map layer default.</entry>
+</row>
 </tbody>
 </tgroup>
 </table>
 
+<variablelist>
+  <varlistentry>
+    <listitem><para>Internal Map Ids:</para></listitem>
+    <listitem><para>OSM Mapnik = 13</para></listitem>
+    <listitem><para>OSM Cycle = 17</para></listitem>
+    <listitem><para>Mapquest OSM = 19</para></listitem>
+  </varlistentry>
+</variablelist>
+
+<para>
+An example to open at a specified location with an OSM Mapnik map layer:
+<screen>viking --latitude 51.4 --longitude -1.3 --zoom 12 --map 13</screen>
+If a file is also specified on the command line, the command line location and zoom parameters will take precendence.
+</para>
+
 <note>
 <para>
 As a special combination when both <emphasis>-V and -d</emphasis> are both enabled at the same time, &appname; will not delete some of the temporary files created during the program run.