routino-router-slim(1)

NAME
routino-router-slim - calculate routes using the routino database

SYNOPSIS
\FCroutino-router-slim\F[]
[\FC--version\F[]] [\FC--help\F[] | \FC--help-profile-xml\F[] | \FC--help-profile-json\F[] | \FC--help-profile-perl\F[]] [\FC--dir=dirname\F[]] [\FC--prefix=name\F[]] [\FC--profiles=filename\F[]] [\FC--translations=filename\F[]] [\FC--exact-nodes-only\F[]] [\FC--quiet\F[]] [\FC--loggable\F[]] [\FC--logtime\F[]] [\FC--logmemory\F[]] [\FC--language=lang\F[]] [\FC--output-html\F[]] [\FC--output-gpx-track\F[]] [\FC--output-gpx-route\F[]] [\FC--output-text\F[]] [\FC--output-text-all\F[]] [\FC--output-none\F[]] [\FC--output-stdout\F[]] [\FC--profile=name\F[]] [\FC--transport=transport\F[]] [\FC--shortest\F[] | \FC--quickest\F[]] \FC--lon1=longitude\F[] \FC--lat1=latitude\F[] \FC--lon2=longitude\F[] \FC--lat2=latitude\F[] [... \FC--lon99=longitude\F[] \FC--lat99=latitude\F[]] [\FC--reverse\F[]] [\FC--loop\F[]] [\FC--highway-<highway>=preference\F[] ...] [\FC--speed-<highway>=speed\F[] ...] [\FC--property-<property>=preference\F[] ...] [\FC--oneway=0|1\F[]] [\FC--turns=0|1\F[]] [\FC--weight=weight\F[]] [\FC--height=height\F[]] [\FC--width=width\F[]] [\FC--length=length\F[]]

DESCRIPTION
routino-router-slim performs the calculation of the optimum routes using the database generated by the planetsplitter(1) program.

OPTIONS

\FC--version\F[]
    Print the version of Routino.

\FC--help\F[]
    Prints out the help information.

\FC--help-profile\F[]
    Prints out the selected transport profile (type, speed limits, highway preferences etc.)

\FC--help-profile-xml\F[]
    Prints out all the loaded profiles as an XML file in the same format that can be loaded in.

\FC--help-profile-json\F[]
    Prints out all the loaded profiles in JavaScript Object Notation (JSON) format for use in the interactive webpage.

\FC--help-profile-perl\F[]
    Prints out all the loaded profiles as a Perl object for use in the router CGI.

\FC--dir\F[]=dirname
    Sets the directory name in which to read the local database. Defaults to the current directory.

\FC--prefix\F[]=name
    Sets the filename prefix for the files in the local database. Defaults to no prefix.

\FC--profiles\F[]=filename
    Sets the filename containing the list of routing profiles in XML format. If the file doesn't exist then \FC--dirname\F[], \FC--prefix\F[] and "profiles.xml" will be combined and used, if that doesn't exist then the file \FC/usr/share/routino/profiles.xml\F[] (or custom installation location) will be used.

\FC--translations\F[]=filename
    Sets the filename containing the list of translations in XML format for the output files. If the file doesn't exist then \FC--dirname\F[], \FC--prefix\F[] and "translations.xml" will be combined and used, if that doesn't exist then the file \FC/usr/share/routino/translations.xml\F[] (or custom installation location) will be used.

\FC--exact-nodes-only\F[]
    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).

\FC--quiet\F[]
    Don't generate any screen output while running (useful for running in a script).

\FC--loggable\F[]
    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.

\FC--logtime\F[]
    Print the elapsed time for each processing step (minutes, seconds and milliseconds).

\FC--logmemory\F[]
    Print the maximum allocated and mapped memory for each processing step (MBytes).

\FC--language\F[]=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.

\FC--output-html\F[], \FC--output-gpx-track\F[], \FC--output-gpx-route\F[], \FC--output-text\F[], \FC--output-text-all\F[]
    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.

\FC--output-none\F[]
    Do not generate any output or read in any translations files.

\FC--output-stdout\F[]
    Write to stdout instead of a file (requires exactly one output format option, implies \FC--quiet\F[]).

\FC--profile\F[]=name
    Specifies the name of the profile to use.

\FC--transport\F[]=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 \FC--profile\F[] option is not given and a profile matching the transport name is found.

\FC--shortest\F[]
    Find the shortest route between the waypoints.

\FC--quickest\F[]
    Find the quickest route between the waypoints.

\FC--lon1\F[]=longitude, \FC--lat1\F[]=latitude, \FC--lon2\F[]=longitude, \FC--lat2\F[]=latitude, ... \FC--lon99\F[]=longitude, \FC--lat99\F[]=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.

\FC--reverse\F[]
    Find a route between the waypoints in reverse order.

\FC--loop\F[]
    Find a route that returns to the first waypoint after the last one.

\FC--heading\F[]=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.

\FC--highway-<highway>\F[]=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 \FC--transport\F[] option.

\FC--speed-<highway>\F[]=speed
    Selects the speed limit in km/hour for each type of highway. Default value depends on the profile selected by the \FC--transport\F[] option.

\FC--property-<property>\F[]=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 \FC--transport\F[] option.

\FC--oneway=\F[]=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 \FC--transport\F[] option.

\FC--turns=\F[]=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 \FC--transport\F[] option.

\FC--weight\F[]=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 \FC--transport\F[] option.

\FC--height\F[]=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 \FC--transport\F[] option.

\FC--width\F[]=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 \FC--transport\F[] option.

\FC--length\F[]=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 \FC--transport\F[] 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.

EXAMPLES
Example usage (motorcycle journey, scenic route, not very fast):

\FC
routino-router-slim --dir=data --prefix=gb --transport=motorcycle \
                    --highway-motorway=0 --highway-trunk=0 \
                    --speed-primary=80 --speed-secondary=80 \
                    --quickest
      \F[]

This will use the files \FCdata/gb-nodes.mem\F[], \FCdata/gb-segments.mem\F[] and \FCdata/gb-ways.mem\F[] to find the quickest route by motorcycle not using motorways or trunk roads and not exceeding 80 km/hr.