Configuration/Full list of options

From Navit's Wiki
< Configuration
Revision as of 14:57, 29 January 2012 by Sleske (talk | contribs) (Full options: explain new global debug level)
Jump to: navigation, search

XML structure

The image below details the complete xml tag structure for the default navit.xml. The colour scheme of the image is designed to give an impression of what is and what isn't required (both for Navit to run succesfully in the first place, and to have a functional navigation system) - those tags in blue are required, whilst those in green can be regarded as optional.
Navit.xml architecture.png

Full options

Navit configuration options
Tag Attribute Units Values Notes Example
language "en_US",
Enables manual setting of the locale. For example, language="en_US" will force Navit to consider the host device as being setup for USA English, and the town search will automatically revert to towns in the USA. This is useful if your device is from another country, or you are travelling in another country. The locale code is made up of the language (lowercase) and the country (uppercase) codes. For language codes, see ISO 639-1; for country codes, see ISO 3166-1 Alpha2. language="en_US"
name "gui_internal", "navit:do_draw", "global" Set the debug level for a Navit module. "name" is the module name; optionally, the name of a function in that module can be appended with a colon (:). The modules correspond to the directories of Navit's source code tree (the module name is set in the in each directory, by a statement "-DMODULE=XXX"). Additionally, there are some special module names: Setting a debug level > 0 for "timestamps" will enable printing of timestamps in debug messages. Setting "segv" to 1 will print backtraces on segmentation faults, setting it to >1 will start gdb. Finally, "global" sets the global debug level (applies to all modules; this is the same as using the command line option -d). name="gui_internal"
level debug level (0-3). The debug level to set for the component given by the "name" attribute. The higher the debug level, the more debug output will be printed. The default debug level is 0, which will only print error messages. level="3"
center coords DD.dd or Map will be centred at these coordinates on startup. Coordinates are either in decimal degrees (with sign in front to denote N/S or E/W) or decimal minutes with trailing N/S or E/W where appropriate.
Default: 53.13 11.70
center="4808 N 1134 E"
orientation 0 / -1 orientation="0": Map oriented North.
orientation="-1": Map oriented in direction of travel.
This is equivalent to selecting Settings -> Rules -> Northing in the internal gui.
tracking 0 / 1 tracking="1": Vehicle cursor will lock to the roads on the map.
This is equivalent to selecting Settings -> Rules -> Lock on road in the internal gui.
zoom 1 - ∞
zoom="1": Most zoomed in. Upper limit is actually 2097152.
Map will be zoomed in at this level on startup.
autozoom_active 0 / 1 autozoom_active="0": Autozoom disabled.
autozoom_active="1": Autozoom enabled.
autozoom_secs seconds 1 - ∞
Number of seconds of the way ahead to leave visible during autozoom.
In effect, this specifies the zoom level when autozoom is enabled.
autozoom_secs="1" is closest zoom.
This attribute has no effect without autozoom_active="1".
imperial 0/1 Use imperial units (miles, feet and miles-per-hour). Only in Navit versions since r4127. imperial="1"
osd_configuration 1 - 32 Sets the initial value of osd_configuration when Navit starts up. osd_configuration="1"
pitch degrees 1 - 359 pitch="0": Bird's-eye view of map.
pitch="20": Map tilted by 20 degrees to give 3D view.
radius percent 1 - 100
Percentage of screen size to offset vehicle cursor from centre when moving.
This causes the map to "lead" the vehicle, showing more of where you're going and less of where you've been.
recent_dest 1 - ∞
Number of entries kept in destination.txt. This text file stores the most recent destinations set by the user in Navit.
Default: ∞
timeout gps updates 1 - ∞
When the user scrolls the map, it stays there. After timeout number of GPS updates the map jumps back to the current location of the active vehicle. (see #653) timeout="5"
graphics Insert inbetween <navit> ... </navit> tags
type gtk_drawing_area
Type of graphics to use for display. graphics="gtk_drawing_area"
gui Insert inbetween <navit> ... </navit> tags
type gtk
Type of user interface to use type="internal"
enabled yes / no Enable this user interface. This attribute enables you to define multiple user interfaces within navit.xml (i.e. multiple <gui> ... </gui> tags), and quickly switch between them by changing the enabled status. enabled="yes"
font_size Pt fractions 1 - ∞ The base text size to use for text and labels in the menus. This only applies when type="internal" font_size="350"
icon_xs pixels 1 - ∞ The size that extra-small style icons should be scaled to (e.g. country flag on town search). This only applies when type="internal" icon_xs="32"
icon_s pixels 1 - ∞ The size that small style icons should be scaled to (e.g. icons of internal GUI toolbar). This only applies when type="internal" icon_s="96"
icon_l pixels 1 - ∞ The size that large style icons should be scaled to (e.g. icons of internal GUI menu). This only applies when type="internal" icon_l="96"
fullscreen 0 / 1 fullscreen="1": Start Navit in fullscreen mode fullscreen="1"
menubar 0 / 1 Toggle display of the menu bar. This only applies when type="gtk" menubar="1"
menu_on_map_click 0 / 1 Toggles the ability to bring up the menu screen when clicking on the map. When using menu_on_map_click="0" it is recommended to use an OSD button with the command, or else you can't get to the menu screen! This only applies when type="internal" menu_on_map_click="0"
toolbar 0 / 1 Toggle display of the toolbar. This only applies when type="gtk" toolbar="1"
statusbar 0 / 1 Toggle display of the status bar. This only applies when type="gtk" statusbar="1"
log Insert inbetween <navit> ... </navit> tags for type="textfile_debug".
Insert inbetween <vehicle> ... </vehicle> tags for all other types.
type nmea
Type of log to output.
type="nmea": outputs data as NMEA messages (the data format used by most GPS receivers).
type="gpx": outputs GPX XML files (e.g. for upload to OpenStreetMap).
type="textfile": creates a text file that can be used as a map within Navit
type="binfile": outputs a binary map file for use within Navit
type="textfile_debug": outputs a debug text file.
enabled yes / no Enable logging. This attribute enables you to define multiple log types within navit.xml (i.e. multiple <log> ... </log> tags), and quickly switch between them by changing the enabled status. enabled="yes"
data filename The name for the logfile. There is support for date and time placeholders:
%Y: Current year
%m: Current month
%d: Current day
%i: Next sequential logfile number (to make the filename unique)
overwrite 0 / 1 Toggle to choose whether an existing tracklog of the same name gets:
overwrite="0": Appended to, or
overwrite="1": overwritten
flush_size bytes 0 - ∞ The file is kept in memory and will be committed to disk if the size reaches the flush_size limit.
flush_size="0": Writes the tracklog to disk immediately.
When used in combination with flush_time, whichever limit is reached first triggers a disk write.
flush_time seconds 0 - ∞ The file is kept in memory and will be committed to disk after flush_time seconds.
flush_time="0": Writes the tracklog to disk immediately.
When used in combination with flush_size, whichever limit is reached first triggers a disk write.
attr_types position_time_iso8601
Comma-separated list which determines what information will be stored in the log file (in addition to the position, and only if supported by the GPS receiver). This only applies when type="gpx"
See Configuring_Navit#Logging_Trips for descriptions of each type.
osd Insert inbetween <navit> ... </navit> tags.
See OSD for comprehensive information on on-screen display settings.
vehicle Insert inbetween <navit> ... </navit> tags.
name vehiclename Name of the vehicle being defined. This can be any name you like, but it's usually best to provide descriptive names, perhaps depending on the gps source, or the type of vehicle. name="Car gpsd"
profilename profilename The name of the vehicle profile (see below) to use for routing and announcements for this vehicle. profilename="car"
source Source of GPS data. See Configuring_Navit#Vehicle for the available options. source="gpsd://localhost"
active 0 / 1 Makes the vehicle the active vehicle in Navit - i.e. all its options are used for routing, view centering and map redraws. Note that a vehicle must be enabled="yes" before it can be made active="1". active="1"
baudrate baud rate 0 - ∞ Baudrate of the com port of a WinCE device. Required if source="wince:COMx:" (where x is the COM port of the gps device). The baud rate should be 4800 in most cases. baudrate="4800"
enabled yes / no Enable the vehicle. This attribute enables you to define multiple vehicles within navit.xml (i.e. multiple <vehicle> ... </vehicle> tags), and quickly switch between them by changing the enabled status or by using the menu options within Navit.
If there is no enabled= tag, the vehicle is automatically enabled.
follow 0 - ∞ Specifies how many GPS updates to wait before map is refreshed. A value of zero means vehicle will leave the edge of the map before the map is refreshed. follow="1"
lag 0 - ∞ Vehicle position extrapolation - it specifies how many tenths of a second the gps lags behind and counteracts with an position extrapolation, to set the cursor at the right position. Also, it affects the speech announcement distances . 10-20 are recommended values. lag="10"
gpsd_query gpsd query Command to send to gpsd. Required if source="gpsd://localhost", otherwise this is not used.
The string used in the example is sufficient for use in Navit.
tracking Insert inbetween <navit> ... </navit> tags.
cdf_histsize metres 0 - ∞ Cumulative displacement filter. Currently not used by Navit. See [1] for what it would do. cdf_histsize="4"
vehicleprofile Insert inbetween <navit> ... </navit> tags.
name profilename The name of the vehicle profile. This name is used by the profilename attribute inside the vehicle tag. name="car"
flags hex value The flags (as defined in AF_* in attr.h) which needs to be set to be able to pass this road. See VehicleprofileFlags for a comprehensive list of bit values. flags="0x4000000"
flags_forward_mask hex value The bits the flags_forward_mask has set in addition to flags, a way must not have set in order to be used in forward direction. More technically: the flags of a way are ANDed with this mask, if the route uses the way in forward direction. The result must match flags otherwise the way must not be used. E.g. flags_forward_mask="0x4000000" and flags_forward_mask="0x4000002" means a road may be used in forward direction if it is a ONEWAYREV (See VehicleprofileFlags). flags_forward_mask="0x40000000"
flags_reverse_mask hex value Identical to flags_forward_mask for ways in the reverse direction. flags_reverse_mask="0x40000000"
maxspeed_handling 0 - 2 maxspeed_handling="0": Always handle the maxspeed attribute of a street.
maxspeed_handling="1": Only handle the maxspeed attribute of a street if it restricts the speed.
maxspeed_handling="2": Never. Reason behind this is that a pedestrian doesn't want to travel with 30 km/h when there is a speed limit.
route_mode 0 - 2 route_mode="0": Automatically select between an on-road route and an off-road route (if the off-0road route is shorter than the distance to the next street from the current position plus the distance to the next street from the destination).
route_mode="1": Always use an on-road route.
route_mode="2":: Always us an off-road route
static_speed km/h 0 - ∞ If the speed between positions from two gps updates is larger than static_speed Navit will accept the new position. static_speed="5"
static_distance metres 0 - ∞ If the distance between positions from two gps updates is larger than static_distance Navit will accept the new position. static_distance="25"
roadprofile Insert inbetween <vehicleprofile> ... </vehicleprofile> tags.
item_types Types of ways for which this roadprofile is valid. Way types can be found in FIXME. item_types="steps"
route_weight km/h 0 - ∞ The weighting which the routing algorithm should give this road type. A large route_weight will force the routing algorithm to choose that road type over others when calculating a route. This value is also used to calculate the route time remaining IF maxspeed_handling="2". route_weight="150"
speed km/h 0 - ∞ Used solely for calculating the estimated time of arrival. speed="50"
maxspeed km/h 0 - ∞ When driving, Navit will use the maxspeed of the road type to inform the driver of the current speed limit using the speed_warner. maxspeed will only be used if there is no OSM speed data for that road. This data is not used for routing calculations. maxspeed="50"
announcement Insert inbetween <roadprofile> ... </roadprofile> tags. Although included in the default navit.xml, announcement tags in roadprofile are currently not honoured. Please use the announce tag within navigation (see below).
level 0, 1, 2 Type of oral announcement to make. For example, level="2" means an announcement such as "turn left soon" will be made; level="1" is "turn left in x metres"; level="0" is "turn left now". level="0"
distance_metric metres 0 - ∞ Distance from the upcoming manoeuvre to perform the announcement. distance_metric="25"
navigation Insert inbetween <navit> ... </navit> tags.
announce Insert inbetween <navigation> ... </navigation> tags.
type Types of ways for which this announcement is valid type="street_0,street_1_city"
level0 0 - ∞ FIXME level0="25"
level1 0 - ∞ FIXME level1="100"
level2 0 - ∞ FIXME level2="200"
unit m FIXME unit="m"
speech Insert inbetween <navit> ... </navit> tags.
type Types of speech output to use type="cmdline"
data Command for speech output. Navit speech_cmdline interfce has sufficient changes applied with svn #4459. For examples and discussion see Configuring_Navit#Speech. data="flite -t %s"
cps 0 - ∞ Speed at which Navit should speak in characters-per-second. cps="15"
mapset Insert inbetween <navit> ... </navit> tags.
enabled yes/no Enable this set of maps. Multiple mapsets can be defined in navit.xml, but only one mapset can be enabled at-a-time. Each mapset, however, can include multiple maps. enabled="yes"

map Insert inbetween <mapset> ... </mapset> tags.
type mg
Type of map. mg = Marco_Polo_Grosser_Reiseplaner; binfile = OpenStreetMap; textfile = Navit textfile; csv = Navit csv format. type="binfile"
enabled yes/no Enable/disable this map. A mapset can include multiple maps. enabled="yes"
data filename Path to the map file. data="/media/MapsNavit/osm.bin"
layout Insert inbetween <navit> ... </navit> tags.
name layoutname Name of the particular layout name="Car"
nightlayout layoutname Defines which layout to use at night, if this layout is the default layout during the day. nightlayout="Car-dark"
color (hex triplet) color Default background color of the map. color="#ffefb7"
font font-face Default font-face to use for road and POI names. font="Liberation Sans"
active 0/1 Set the layout as the default using active="1". Added in r4342. active="1"
order_delta 0-∞ Increases the zoom level at which items are rendered. FIXME. order_delta="1"
cursor Insert inbetween <layout> ... </layout> tags. Cursor position is controlled by <navit radius="value">
w pixels Width of cursor. w="26"
h pixels Height of cursor h="26"
itemgra Insert inbetween <cursor> ... </cursor> tags.
speed_range km/h 0 - ∞ Range of speeds within which to show the specific geometry of the subsequently defined cursor.

speed_range="-2": subsequent geometry will be displayed at speeds <= 2km/h.
speed_range="3-": subsequent geometry will be displayed at speeds >= 3km/h.
speed_range="6-10": subsequent geometry will be displayed at speeds between 6 and 10km/h inclusive.