manual.html

A car navigation system for Unix and PocketPC.

active).</td>
</tr>
<tr valign="top">
<td align="left">E:</td>
<td align="left">Next sunset time (evening), undefined in night time.</td>
</tr>
<tr valign="top">
<td align="left">F:</td>
<td align="left">the full name (number, name, city) of the selected or current
street.</td>
</tr>
<tr valign="top">
<td align="left">M:</td>
<td align="left">Next sunrise time (morning), undefined in daylight time.</td>
</tr>
<tr valign="top">
<td align="left">N:</td>
<td align="left">the name of the selected or current street.</td>
</tr>
<tr valign="top">
<td align="left">S:</td>
<td align="left">Speed (set only when a trip is active).</td>
</tr>
<tr valign="top">
<td align="left">T:</td>
<td align="left">Current time, format HH:MM (set only when a trip is
active).</td>
</tr>
<tr valign="top">
<td align="left">W:</td>
<td align="left">Distance to the next waypoint (set only when a trip is
active).</td>
</tr>
<tr valign="top">
<td align="left">#:</td>
<td align="left">the street number range to the selected or current street
block.</td>
</tr>
</table></center><p>Note that the time is always shown using the military
format: HH:MM.</p><p>Example: &quot;%D (%W)&quot; shows the distance to the
destination point, followed by the distance to the next waypoint (in
parenthesis).</p><p>A message is evaluated, and displayed, only when all
referenced macros have a defined value. Therefore the example above will show
nothing if there is no trip active, or if there is no next waypoint. It is
possible to define several alternatives, separated by the character '|': the
first alternative that has been successfully evaluated will be
displayed.</p><p>Example: &quot;%D (%W)|%D&quot; shows both distances to the
destination point and to the next waypoint if both distances are defined, or
else only the distance to the destination point if this distance is defined.
If none of the two distance have been defined (for example when no trip is
active), then no display is shown and/or no sound is produced.</p><p>Another
typical example is &quot;sunset: %E|sunrise: %M&quot;, which shows the next
sunset (in daylight time) or sunrise (in night time).</p><p>It is possible to
&quot;link&quot; together parts of a string using simple or double quotes.
This is used when the string specifies an external command to execute. RoadMap
does not use the shell to execute commands (so to stay independent from the
OS-specific shell syntax), but it does recognise the use of quotes to specify
a command parameter that includes spaces. Such a parameter may be enclosed in
single or double quotes. There is no difference between one quote or another,
except that the parameter must be terminated with the same quote character it
was started with.</p><p>Example: &quot;flite -t 'On %N'&quot; to specify the
command flite with two parameters (&quot;-f&quot; and &quot;On
%N&quot;).</p><h2><a id="id.s7.3" name="id.s7.3">7.3 </a>A NOTE REGARDING
COLORS<a href="#id.toc"><img src="apt_toc.gif" border="0" width="30" height="11" alt="Contents"></a></h2>
<p>Some RoadMap configuration items define colors to be used. As a general
rule a color must be described in a way that is suitable for the target
graphic system.</p><p>In the case of X11, that means either a color name (as
defined in the /etc/X11/rgb.txt) or a color definition: #rrggbb where rr, gg
and bb are hexadecimal values (for example: #FFFFFF is white, #000000 is
black).</p><p>Note that the #rrggbb format is broadly supported, even on
target systems that do not support named
colors.</p><h2><a id="id.s7.4" name="id.s7.4">7.4 </a>PREFERENCE
ITEMS<a href="#id.toc"><img src="apt_toc.gif" border="0" width="30" height="11" alt="Contents"></a></h2>
<dl compact>
<dt><b>General.Unit</b></dt>
<dd>The unit system used, either &quot;imperial&quot; or
&quot;metric&quot;<p><b>Default:</b> imperial</p></dd>
<dt><b>General.Default Zoom</b></dt>
<dd>The zoom level when roadmap is started.<p><b>Format:</b>
integer</p><p><b>Default:</b> 60</p></dd>
<dt><b>General.Keyboard</b></dt>
<dd>Show (yes) or hide (no) a keyboard on the screen.<p><b>Format:</b>
boolean</p><p><b>Default:</b> yes</p></dd>
<dt><b>General.Icons</b></dt>
<dd>Show (yes) or hide (no) the roadmap icons.<p><b>Format:</b>
boolean</p><p><b>Default:</b> yes</p><p><b>Command line option:</b>
--no-icon</p></dd>
<dt><b>General.Toolbar</b></dt>
<dd>Show (yes) or hide (no) the roadmap toolbar.<p><b>Format:</b>
boolean</p><p><b>Default:</b> yes</p><p><b>Command line option:</b>
--no-toolbar</p></dd>
<dt><b>Geometry.Main</b></dt>
<dd>Sets the size of the RoadMap main window.<p><b>Format:</b>
<i>WIDTH</i>x<i>HEIGHT</i></p><p><b>Default:</b> 800x600</p></dd>
<dt><b>Geometry.WINDOW</b></dt>
<dd>Sets the size of the RoadMap window named WINDOW.<p><b>Format:</b>
<i>WIDTH</i>x<i>HEIGHT</i></p><p><b>Default:</b> 300x200</p></dd>
<dt><b>Display.Bottom Right</b></dt>
<dd>Defines the message on the bottom right corner.<p><b>Format:</b> RoadMap
format string</p><p><b>Default:</b> %D (%W)|%D</p></dd>
<dt><b>Display.Bottom Left</b></dt>
<dd>Defines the message on the bottom left corner.<p><b>Format:</b> RoadMap
format string</p><p><b>Default:</b> %S</p></dd>
<dt><b>Display.Top Right</b></dt>
<dd>Defines the message on the top right corner.<p><b>Format:</b> RoadMap
format string</p><p><b>Default:</b> ETA: %A|%T</p></dd>
<dt><b>Display.Duration</b></dt>
<dd>The time during which a selection or message is shown.<p><b>Format:</b>
number of seconds.</p><p><b>Default:</b> 10</p><p><b>Comment:</b> the
selection is only removed when the map is redrawn.</p></dd>
<dt><b>Help.Browser</b></dt>
<dd>The browser program used to show the help text.<p><b>Format:</b> a program
name, with or without path.</p><p><b>Default:</b> dillo</p></dd>
<dt><b>Help.Arguments</b></dt>
<dd>The browser's command line arguments<p><b>Format:</b> a format string,
with one '%s' for the help URL.</p><p><b>Default:</b> %s</p></dd>
<dt><b>Map.Path</b></dt>
<dd>The map database search path.<p><b>Format:</b> a comma-separated list of
directory paths.</p><p><b>Default:</b>
~/.roadmap/maps,/var/lib/roadmap,/usr/lib/roadmap</p><p><b>Comment:</b> the
default also includes /usr/local/share/roadmap and /usr/share/roadmap, for
compatibility purposes. These two directories were the standard locations for
the maps in previous versions of RoadMap.</p></dd>
<dt><b>Map.Cache</b></dt>
<dd>The number of entries in RoadMap's mapping cache.<p><b>Format:</b>
integer</p><p><b>Default:</b> 8</p></dd>
<dt><b>Map.Background</b></dt>
<dd>The color used for the background of the maps.<p><b>Format:</b>
color</p><p><b>Default:</b> LightYellow</p></dd>
<dt><b>Map.Signs</b></dt>
<dd>Enable/disable the map sprites and street signs.<p><b>Format:</b>
boolean</p><p><b>Default:</b> yes</p><p><b>Comment:</b> use only in special
cases (very small screens)</p></dd>
<dt><b>Map.Refresh</b></dt>
<dd>Forces a screen refresh every time.<p><b>Format:</b> enumeration (normal /
forced)</p><p><b>Default:</b> normal</p></dd>
<dt><b>GPS.Background</b></dt>
<dd>The background color for the RoadGps screen.<p><b>Format:</b>
color</p><p><b>Default:</b> LightYellow</p><p><b>Comment:</b> this color is
used by RoadGps, not by RoadMap.</p></dd>
<dt><b>GPS.Foreground</b></dt>
<dd>The foreground color for the RoadGps screen.<p><b>Format:</b>
color</p><p><b>Default:</b> Black</p><p><b>Comment:</b> this color is used by
RoadGps, not by RoadMap.</p></dd>
<dt><b>GPS.Timeout</b></dt>
<dd>A timeout for detecting that the GPS link is down.<p><b>Format:</b> number
of seconds.</p><p><b>Default:</b> 10</p><p><b>Comment:</b> the GPS link is
considered down if no new GPS data was received for the specified amount of
time.</p></dd>
<dt><b>GPS.Source</b></dt>
<dd>The URL that gives the address of the GPS data source.<p><b>Format:</b>
gpsd://<i>hostname</i>[:<i>port</i>]</p><p><b>Default:</b>
gpsd://localhost</p><p><b>Comment:</b> the syntax
&quot;file://<i>path</i>&quot; is also possible, for debug.</p></dd>
<dt><b>GPS.Color</b></dt>
<dd>The color used for the current GPS position symbol.<p><b>Format:</b>
color</p><p><b>Default:</b> green</p><p><b>Comment:</b> this color is used by
RoadMap, not by RoadGps.</p></dd>
<dt><b>Destination.Color</b></dt>
<dd>The color used for the destination symbol.<p><b>Format:</b>
color</p><p><b>Default:</b> red</p><dl compact>
<dt><b>Selected Street.Background</b></dt>
<dd>The color for the background of the selected street name.<p><b>Format:</b>
color</p><p><b>Default:</b> yellow</p></dd>
</dl></dd>
<dt><b>Selected Street.Foreground</b></dt>
<dd>The color for the foreground of the selected street name.<p><b>Format:</b>
color</p><p><b>Default:</b> black</p></dd>
<dt><b>Selected Street.Text</b></dt>
<dd>The format used for the selected street's display.<p><b>Format:</b>
RoadMap format string</p><p><b>Default:</b> %F</p></dd>
<dt><b>Console.Background</b></dt>
<dd>The color used for the background of the trip display.<p><b>Format:</b>
color</p><p><b>Default:</b> yellow</p></dd>
<dt><b>Console.Foreground</b></dt>
<dd>The color used for the foreground of the trip display.<p><b>Format:</b>
color</p><p><b>Default:</b> black</p></dd>
<dt><b>Current Street.Background</b></dt>
<dd>The color for the background of the current street's
name.<p><b>Format:</b> color</p><p><b>Default:</b> DarkSeaGreen4</p></dd>
<dt><b>Current Street.Foreground</b></dt>
<dd>The color for the foreground of the current street's
name.<p><b>Format:</b> color</p><p><b>Default:</b> white</p></dd>
<dt><b>Current Street.Text</b></dt>
<dd>The text used to display the current street's name.<p><b>Format:</b>
color</p><p><b>Default:</b> black <i>(I would recommend using white--see
above)</i></p><p><b>Default:</b> %N, %C|%N</p></dd>
<dt><b>Voice.Current Street</b></dt>
<dd>The command used to announce the current street's name.<p><b>Format:</b>
RoadMap format string</p><p><b>Default:</b> flite -t 'On %N'</p></dd>
<dt><b>Voice.Selected Street</b></dt>
<dd>The command used to announce the selected street's name.<p><b>Format:</b>
RoadMap format string</p><p><b>Default:</b> flite -t '%N'</p></dd>
<dt><b>Voice.Next Intersection</b></dt>
<dd>The command used to announce the name of the next
intersection.<p><b>Format:</b> RoadMap format string</p><p><b>Default:</b>
flite -t 'Next intersection: %N'</p></dd>
<dt><b>Voice.Approach</b></dt>
<dd>Reserved for future use (approaching waypoint).</dd>
<dt><b>Accuracy.Confidence</b></dt>
<dd>The minimum rating for a street to be selected<p><b>Format:</b> integer,
range 0 .. 1024</p><p><b>Default:</b> 25</p><p><b>Comment:</b> RoadMap uses
fuzzy logic to identify what street the vehicule is on. This value if a
minimum fuzzy result for RoadMap to select any street. This helps not
selecting whatever street is near by when off-road. This also speeds up the
identification process by filtering out unlikely matches.</p></dd>
<dt><b>Accuracy.GPS Position</b></dt>
<dd>The GPS's estimated position error (worst case)<p><b>Format:</b>
integer</p><p><b>Default:</b> 300</p><p><b>Comment:</b> the unit depends on
the selected unit system (feet or meter). The default shown being tuned for
feet. This default accuracy can be adjusted to the actual GPS estimate if a
Garmin GPS receiver is used.</p></dd>
<dt><b>Accuracy.GPS Speed</b></dt>
<dd>GPS's spee