[DOC] Some words about the viking.ini file

diff --git a/doc/viking.xml b/doc/viking.xml
index dd845a89f7b1cd5e5e1761ddb8968d766aaffec9..0f7689e71454f81b4b708b0a649701b4d79d4649 100644 (file)
--- a/doc/viking.xml
+++ b/doc/viking.xml
@@ -409,6 +409,14 @@ and docbook-xsl in your Build-Depends control field.
           <para>Layer default values for &dhpackage;.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><filename>~/.viking/viking.ini</filename></term>
+        <listitem>
+          <para>Values for &dhpackage; automatically saved between sessions.</para>
+          <para>Not generally intended to be manually edited.</para>
+         <para>However some finer control of default internal values can be set.</para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><filename>~/.viking/cookies.txt</filename></term>
         <listitem>

diff --git a/help/C/viking.xml b/help/C/viking.xml
index 569509a8753c65fd6931a5348fa55c409830ee23..88749c9a50f26846fa38df6e03cc611dfd1520ef 100644 (file)
--- a/help/C/viking.xml
+++ b/help/C/viking.xml
@@ -2507,6 +2507,41 @@ Accept: */*
         <para>The <envar>XDG_DATA_HOME</envar> environment variable is also used (if set) to look for these extension files.</para>
       </section>
 
+
+      <section>
+        <title>Miscellaneous Settings</title>
+        <para>Various individual values are automatically saved between &app; sessions in the <filename>~/.viking/viking.ini</filename> file.</para>
+        <para>This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired.</para>
+        <para>Some values in this file are <emphasis>read only</emphasis>, in the sense that there is no way to set it other than by manually entering in the keys and values (the key will not exist in the file otherwise). This allows some fine tuning of &app; behaviours, without resorting to recompiling the code. However is it not expected that these values should need to be changed for a normal user, hence no GUI options for these have been provided.</para>
+        <para>Here is the list of the <emphasis>read only</emphasis> keys and their default values.</para>
+       <orderedlist>
+         <listitem>
+           <para>maps_max_tiles=1000</para>
+         </listitem>
+         <listitem>
+           <para>maps_min_shrinkfactor=0.0312499</para>
+         </listitem>
+         <listitem>
+           <para>maps_max_shrinkfactor=8.0000001</para>
+         </listitem>
+         <listitem>
+           <para>maps_real_min_shrinkfactor=0.0039062499</para>
+         </listitem>
+         <listitem>
+           <para>background_max_threads=10</para>
+         </listitem>
+         <listitem>
+           <para>window_menubar=true</para>
+         </listitem>
+         <listitem>
+           <para>version_check_period_days=14</para>
+         </listitem>
+         <listitem>
+           <para>trackwaypoint_alphabetized=true</para>
+         </listitem>
+       </orderedlist>
+      </section>
+
 </section>
 <!-- End of Extending Viking -->