routino-router - calculate routes using the routino database
routino-router
[--version] [--help | --help-profile-xml |
--help-profile-json | --help-profile-perl]
[--dir=dirname] [--prefix=name]
[--profiles=filename]
[--translations=filename] [--exact-nodes-only]
[--quiet] [--loggable] [--logtime] [--logmemory]
[--language=lang] [--output-html]
[--output-gpx-track] [--output-gpx-route]
[--output-text] [--output-text-all] [--output-none]
[--output-stdout] [--profile=name]
[--transport=transport] [--shortest |
--quickest] --lon1=longitude
--lat1=latitude --lon2=longitude
--lat2=latitude [...
--lon99=longitude
--lat99=latitude] [--reverse] [--loop]
[--highway-<highway>=preference ...]
[--speed-<highway>=speed ...]
[--property-<property>=preference ...]
[--oneway=0|1] [--turns=0|1]
[--weight=weight]
[--height=height] [--width=width]
[--length=length]
routino-router performs the calculation of the optimum
routes using the database generated by the planetsplitter(1)
program.
- --version
- Print the version of Routino.
- --help
- Prints out the help information.
- --help-profile
- Prints out the selected transport profile (type, speed limits, highway
preferences etc.)
- --help-profile-xml
- Prints out all the loaded profiles as an XML file in the same format that
can be loaded in.
- --help-profile-json
- Prints out all the loaded profiles in JavaScript Object Notation (JSON)
format for use in the interactive webpage.
- --help-profile-perl
- Prints out all the loaded profiles as a Perl object for use in the router
CGI.
- --dir=dirname
- Sets the directory name in which to read the local database. Defaults to
the current directory.
- --prefix=name
- Sets the filename prefix for the files in the local database. Defaults to
no prefix.
- --profiles=filename
- Sets the filename containing the list of routing profiles in XML format.
If the file doesn't exist then --dirname, --prefix and
"profiles.xml" will be combined and used, if that doesn't exist
then the file /usr/share/routino/profiles.xml (or custom
installation location) will be used.
- --translations=filename
- Sets the filename containing the list of translations in XML format for
the output files. If the file doesn't exist then --dirname,
--prefix and "translations.xml" will be combined and
used, if that doesn't exist then the file
/usr/share/routino/translations.xml (or custom installation
location) will be used.
- --exact-nodes-only
- When processing the specified latitude and longitude points only select
the nearest node instead of finding the nearest point within a segment
(quicker but less accurate unless the points are already near nodes).
- --quiet
- Don't generate any screen output while running (useful for running in a
script).
- --loggable
- Print progress messages that are suitable for logging to a file; normally
an incrementing counter is printed which is more suitable for real-time
display than logging.
- --logtime
- Print the elapsed time for each processing step (minutes, seconds and
milliseconds).
- --logmemory
- Print the maximum allocated and mapped memory for each processing step
(MBytes).
- --language=lang
- Select the language specified from the file of translations. If this
option is not given and the file exists then the first language in the
file will be used. If this option is not given and no file exists the
compiled-in default language (English) will be used.
- --output-html,
--output-gpx-track, --output-gpx-route, --output-text,
--output-text-all
- Generate the selected output file formats (HTML, GPX track file, GPX route
file, plain text route and/or plain text with all nodes). If no output is
specified then all are generated, specifying any automatically disables
those not specified.
- --output-none
- Do not generate any output or read in any translations files.
- --output-stdout
- Write to stdout instead of a file (requires exactly one output format
option, implies --quiet).
- --profile=name
- Specifies the name of the profile to use.
- --transport=transport
- Select the type of transport to use, transport can be set to:
foot |
= |
Foot |
horse |
= |
Horse |
wheelchair |
= |
Wheelchair |
bicycle |
= |
Bicycle |
moped |
= |
Moped (Small motorcycle, limited speed) |
motorcycle |
= |
Motorcycle |
motorcar |
= |
Motorcar |
goods |
= |
Goods (Small lorry, van) |
hgv |
= |
HGV (Heavy Goods Vehicle \- large lorry) |
psv |
= |
PSV (Public Service Vehicle \- bus, coach) |
Defaults to 'motorcar', this option also selects the default
profile information if the --profile option is not given and a
profile matching the transport name is found.
- --shortest
- Find the shortest route between the waypoints.
- --quickest
- Find the quickest route between the waypoints.
- --lon1=longitude,
--lat1=latitude, --lon2=longitude,
--lat2=latitude, ... --lon99=longitude,
--lat99=latitude
- The location of the waypoints that make up the start, middle and end
points of the route. Up to 99 waypoints can be specified and the route
will pass through each of the specified ones in sequence. The algorithm
will use the closest node or point within a segment that allows the
specified traffic type.
- --reverse
- Find a route between the waypoints in reverse order.
- --loop
- Find a route that returns to the first waypoint after the last one.
- --heading=bearing
- Specifies the initial direction of travel at the start of the route (from
the lowest numbered waypoint) as a compass bearing from 0 to 360
degrees.
- --highway-<highway>=preference
- Selects the percentage preference for using each particular type of
highway. The value of highway can be selected from:
motorway |
= |
Motorway |
trunk |
= |
Trunk |
primary |
= |
Primary |
secondary |
= |
Secondary |
tertiary |
= |
Tertiary |
unclassified |
= |
Unclassified |
residential |
= |
Residential |
service |
= |
Service |
track |
= |
Track |
cycleway |
= |
Cycleway |
path |
= |
Path |
steps |
= |
Steps |
ferry |
= |
Ferry |
Default value depends on the profile selected by the
--transport option.
- --speed-<highway>=speed
- Selects the speed limit in km/hour for each type of highway. Default value
depends on the profile selected by the --transport option.
- --property-<property>=preference
- Selects the percentage preference for using each particular highway
property. The value of property can be selected from:
paved |
= |
Paved (suitable for normal wheels) |
multilane |
= |
Multiple lanes |
bridge |
= |
Bridge |
tunnel |
= |
Tunnel |
footroute |
= |
A route marked for foot travel |
bicycleroute |
= |
A route marked for bicycle travel |
Default value depends on the profile selected by the
--transport option.
- --oneway==0|1
- Selects if the direction of oneway streets are to be obeyed (useful to not
obey them when walking). Default value depends on the profile selected by
the --transport option.
- --turns==0|1
- Selects if turn restrictions are to be obeyed (useful to not obey them
when walking). Default value depends on the profile selected by the
--transport option.
- --weight=weight
- Specifies the weight of the mode of transport in tonnes; ensures that the
weight limit on the highway is not exceeded. Default value depends on the
profile selected by the --transport option.
- --height=height
- Specifies the height of the mode of transport in metres; ensures that the
height limit on the highway is not exceeded. Default value depends on the
profile selected by the --transport option.
- --width=width
- Specifies the width of the mode of transport in metres; ensures that the
width limit on the highway is not exceeded. Default value depends on the
profile selected by the --transport option.
- --length=length
- Specifies the length of the mode of transport in metres; ensures that the
length limit on the highway is not exceeded. Default value depends on the
profile selected by the --transport option.
The meaning of the preference parameter in the command line
options is slightly different for the highway preferences and the property
preferences. For the highway preference consider the choice between two
possible highways between the start and finish when looking for the shortest
route. If highway A has a preference of 100% and highway B has a preference
of 90% then highway A will be chosen even if it is up to 11% longer (100/90
= 111%). For the highway properties each highway either has a particular
property or not. If the preference for the property is 60% then a highway
with the property has a preference of 77% (sqrt(60%)) and one without has a
preference of 63% (sqrt(100-60%)). A highway with the property will be
chosen even if it is up to 22% longer than one without the property (77/63 =
122%). The overall preference for each highway segment is the product of the
preference for the highway type and all of the preferences for the highway
properties.
Example usage (motorcycle journey, scenic route, not very
fast):
routino-router --dir=data --prefix=gb --transport=motorcycle \
--highway-motorway=0 --highway-trunk=0 \
--speed-primary=80 --speed-secondary=80 \
--quickest
This will use the files data/gb-nodes.mem,
data/gb-segments.mem and data/gb-ways.mem to find the quickest
route by motorcycle not using motorways or trunk roads and not exceeding 80
km/hr.