routino-router-slim(1)

๐Ÿ“ฆ
version 3.4.3 ยท 5 versions
, in ubuntu resolute, ubuntu stonking

๐Ÿ’– routino-router-slim(1) ๐Ÿ’–

okay bestie, welcome to the manual page for routino-router-slim(1) โ€” it's giving route-calculator, it's giving main character, and yes we're gonna read the whole thing together. no skimming, no cap. ๐Ÿซถ


โœจ NAME โœจ

routino-router-slim โ€” calculate routes using the routino database ๐Ÿ—บ๏ธ๐Ÿ’…

๐ŸŒธ SYNOPSIS ๐ŸŒธ

routino-router-slim [--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]

๐Ÿ’… DESCRIPTION ๐Ÿ’…

So like, routino-router-slim is the one that actually does the math and figures out the optimum routes, using the database that the planetsplitter(1) program already built for you. it literally vibes off that database, no notes. ๐Ÿ”ฅ

๐Ÿ”ฅ OPTIONS ๐Ÿ”ฅ

  • --version โ€” prints out the version of Routino. iconic, short, slays. โœจ
  • --help โ€” prints out the help information. bestie behaviour honestly. ๐Ÿซถ
  • --help-profile โ€” prints out the selected transport profile โ€” that's the type, the speed limits, the highway preferences, all of it. the whole โœจ dossier โœจ.
  • --help-profile-xml โ€” dumps every loaded profile as an XML file, in the exact same format it can be loaded back in. round trip, no data lost, queen shit. ๐Ÿ‘‘
  • --help-profile-json โ€” dumps all the loaded profiles in JavaScript Object Notation (JSON) format, for using in the interactive webpage. ๐ŸŒˆ
  • --help-profile-perl โ€” dumps all the loaded profiles as a Perl object, for using in the router CGI. we love a cross-language moment. ๐Ÿ’œ
  • --dir=dirname โ€” sets the directory name to read the local database from. defaults to the current directory. (so like, if you don't say anything, it just looks right where you're standing ๐Ÿ )
  • --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" get combined and used instead; and if that doesn't exist then the file /usr/share/routino/profiles.xml (or wherever your custom installation lives) gets used. it's a whole fallback chain, she's prepared. ๐Ÿ’…
  • --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" get combined and used; and if that doesn't exist either, then /usr/share/routino/translations.xml (or your custom installation location) is used. same energy, different file. ๐ŸŒ
  • --exact-nodes-only โ€” when processing the latitude and longitude points you specified, it only picks the nearest node instead of hunting for the nearest point within a segment. quicker, yeah, but less accurate โ€” unless your points are already chilling right near nodes. ๐Ÿ˜ญ
  • --quiet โ€” don't generate any screen output while running. super useful for running inside a script, where nobody wants your chatter. ๐Ÿคซ
  • --loggable โ€” prints progress messages that are actually suitable for logging to a file. normally you'd get an incrementing counter instead, which is better suited to real-time display than to logging. iykyk. ๐Ÿ“
  • --logtime โ€” prints the elapsed time for each processing step, in minutes, seconds and milliseconds. โฑ๏ธ
  • --logmemory โ€” prints the maximum allocated and mapped memory for each processing step, in MBytes. ๐Ÿง 
  • --language=lang โ€” selects the language you name from the file of translations. if you don't pass this option but the file does exist, the first language in the file gets used. if you don't pass it and no file exists at all, the compiled-in default language (English) gets 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 you don't specify any output at all, then all of them get generated; and specifying any of them automatically disables the ones you didn't name. it's giving all-or-specify. ๐ŸŽ€
  • --output-none โ€” do not generate any output, and do not read in any translations files. nothing. zero. void. ๐Ÿ’€
  • --output-stdout โ€” write to stdout instead of to a file. this one needs exactly one output format option, and it implies --quiet. โšก
  • --profile=name โ€” specifies the name of the profile you want to use. ๐Ÿชช
  • --transport=transport โ€” selects 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'. also, this option picks the default profile information if you didn't pass --profile โ€” as long as a profile matching the transport name is actually found. ๐Ÿš—๐Ÿšฒ๐ŸŽ

  • --shortest โ€” find the shortest route between the waypoints. distance girlie. ๐Ÿ“
  • --quickest โ€” find the quickest route between the waypoints. time girlie. โฐ
  • --lon1=longitude, --lat1=latitude, --lon2=longitude, --lat2=latitude, โ€ฆ --lon99=longitude, --lat99=latitude โ€” the location of the waypoints that make up the start, the middle and the end points of the route. you can specify up to 99 waypoints, and the route will pass through each of the ones you specified, in sequence. the algorithm uses the closest node, or the closest point within a segment, that allows the traffic type you asked for. ๐Ÿ“
  • --reverse โ€” find a route between the waypoints, but in reverse order. ๐Ÿ”„
  • --loop โ€” find a route that returns to the first waypoint after the last one. come back home bestie ๐Ÿก
  • --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. 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

The 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. the default value depends on the profile selected by the --transport option. ๐ŸŽ๏ธ
  • --property-<property>=preference โ€” selects the percentage preference for using each particular highway property. 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

The default value depends on the profile selected by the --transport option. ๐ŸŒ‰

  • --oneway==0|1 โ€” selects whether the direction of oneway streets is to be obeyed. (handy when you don't wanna obey them, like when you're walking.) the default value depends on the profile selected by the --transport option. ๐Ÿšซโžก๏ธ
  • --turns==0|1 โ€” selects whether turn restrictions are to be obeyed. (again, super handy when you don't wanna obey them and you're just walking.) the default value depends on the profile selected by the --transport option. โ†ฉ๏ธ
  • --weight=weight โ€” specifies the weight of the mode of transport in tonnes; this makes sure the weight limit on the highway isn't exceeded. the default value depends on the profile selected by the --transport option. โš–๏ธ
  • --height=height โ€” specifies the height of the mode of transport in metres; this makes sure the height limit on the highway isn't exceeded. the default value depends on the profile selected by the --transport option. ๐Ÿ“
  • --width=width โ€” specifies the width of the mode of transport in metres; this makes sure the width limit on the highway isn't exceeded. the default value depends on the profile selected by the --transport option. โ†”๏ธ
  • --length=length โ€” specifies the length of the mode of transport in metres; this makes sure the length limit on the highway isn't exceeded. the default value depends on the profile selected by the --transport option. ๐Ÿ“

okay so the meaning of that preference parameter in the command line options is slightly different depending on whether we're talking highway preferences or property preferences, and this is the part where you gotta lock in bestie ๐Ÿ”’โœจ

For the highway preference, imagine you're choosing between two possible highways between the start and the finish while 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's up to 11% longer (100/90 = 111%). she's worth the detour. ๐Ÿ’…

For the highway properties, each highway either has a particular property or it doesn't. If the preference for the property is 60%, then a highway with the property has a preference of 77% (sqrt(60%)) and one without it has a preference of 63% (sqrt(100-60%)). A highway with the property will be chosen even if it's up to 22% longer than one without the property (77/63 = 122%). ๐Ÿงฎ

And the overall preference for each highway segment? That's the product of the preference for the highway type and all of the preferences for the highway properties. stack 'em, multiply 'em, done. ๐Ÿ”ฅ

โœจ EXAMPLES โœจ

okay bestie let's actually do the thing ๐Ÿ’… here's a real example โ€” a motorcycle journey, scenic route vibes, not very fast:

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

so what's going on here?? let me break it down for you ๐Ÿซถ

this is gonna pull from the files data/gb-nodes.mem, data/gb-segments.mem and data/gb-ways.mem to find the quickest route by ๐Ÿ๏ธ motorcycle that's not using motorways or trunk roads, and not exceeding 80 km/hr. scenic queen behavior fr fr, no cap. it's giving "vibes over velocity" โœจ

like, look at the flags doing their lil jobs:

  • --dir=data + --prefix=gb โ†’ that's where those .mem files come from ๐Ÿ‘‘
  • --transport=motorcycle โ†’ bestie is on two wheels ๐Ÿ๏ธ
  • --highway-motorway=0 and --highway-trunk=0 โ†’ nope, not touching those roads ๐Ÿ™…
  • --speed-primary=80 and --speed-secondary=80 โ†’ capping it at 80 km/hr ๐Ÿ’€
  • --quickest โ†’ fastest route pls, main character energy only โญ

and that's the whole page, gorgeous ๐ŸŒธ go route something iconic, and remember: read the docs, slay the day, periodt ๐Ÿ’–


this lil manual page is from the Routino router-slim source and its version, dated 03 December 2025 โ€” she's serving routino-router-slim(1) and honestly?? iconic. mwah ๐ŸŽ€

๐Ÿ“ฆ where this page comes from