trunk/doc/USAGE.txt

                               Routino : Usage
                               ===============


   There are four programs that make up this software. The first one takes
   the planet.osm datafile from OpenStreetMap (or other source of data
   using the same formats) and converts it into a local database. The
   second program uses the database to determine an optimum route between
   two points. The third program allows visualisation of the data and
   statistics to be extracted. The fourth program is a test program for
   the tag transformations.


planetsplitter
--------------

   This program reads in the OSM format XML file and splits it up to
   create the database that is used for routing.

   Usage: planetsplitter [--help]
                         [--dir=<dirname>] [--prefix=<name>]
                         [--sort-ram-size=<size>] [--sort-threads=<number>]
                         [--tmpdir=<dirname>]
                         [--tagging=<filename>]
                         [--loggable] [--logtime]
                         [--errorlog[=<name>]]
                         [--parse-only | --process-only]
                         [--max-iterations=<number>]
                         [--prune-none]
                         [--prune-isolated=<len>]
                         [--prune-short=<len>]
                         [--prune-straight=<len>]
                         [<filename.osm> ...]

   --help
          Prints out the help information.

   --dir=<dirname>
          Sets the directory name in which to save the results. Defaults
          to the current directory.

   --prefix=<name>
          Sets the filename prefix for the files that are created.
          Defaults to no prefix.

   --sort-ram-size=<size>
          Specifies the amount of RAM (in MB) to use for sorting the data.
          If not specified then 64 MB will be used in slim mode or 256 MB
          otherwise.

   --sort-threads=<number>
          The number of threads to use for data sorting (the sorting
          memory is shared between the threads - too many threads and not
          enough memory will reduce the performance).

   --tmpdir=<dirname>
          Specifies the name of the directory to store the temporary disk
          files. If not specified then it defaults to either the value of
          the --dir option or the current directory.

   --tagging=<filename>
          Sets the filename containing the list of tagging rules in XML
          format for the parsing the input files. 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/local/share/routino/profiles.xml' (or custom installation
          location) will be used.

   --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.

   --errorlog[=<name>]
          Log OSM parsing and processing errors to 'error.log' or the
          specified file name (the '--dir' and '--prefix' options are
          applied).

   --parse-only
          Parse the input files and store them in a temporary file but
          don't process the data into a routing database.

   --process-only
          Don't read in any files but process the existing temporary file
          into the routing database.

   --max-iterations=<number>
          The maximum number of iterations to use when generating
          super-nodes and super-segments. Defaults to 5 which is normally
          enough.

   --prune-none
          Disable the prune options below, they can be re-enabled by
          adding them to the command line after this option.

   --prune-isolated=<length>
          Remove small disconnected groups of segments (defaults to
          removing groups under 500m).

   --prune-short=<length>
          Remove short segments (defaults to removing segments up to a
          maximum length of 5m).

   --prune-straight=<length>
          Remove nodes in almost straight highways (defaults to removing
          nodes up to 3m offset from a straight line).

   <filename.osm> ...
          Specifies the filename(s) to read data from, by default data is
          read from the standard input.

   Note: In version 1.4 of Routino the --transport, --not-highway and
   --not-property options have been removed. The same functionality can be
   achieved by editing the tagging rules file to not output unwanted data.

   Note: In version 1.5 of Routino the --slim option has been removed but
   at compilation time a separate program called planetsplitter-slim is
   created that operates in slim mode. In slim mode the temporary files
   and database files are read as needed rather than being mapped into
   memory. This allows a database size greater than 2 GB on 32-bit
   machines or usage with little or no virtual memory (e.g. some virtual
   machines). The penalty for this is that the program takes about twice
   as long to run.

   Example usage:

   ./planetsplitter --dir=data --prefix=gb great_britain.osm

   This will generate the output files 'data/gb-nodes.mem',
   'data/gb-segments.mem' and 'data/gb-ways.mem'.


router
------

   This program performs the calculation of the optimum routes using the
   database generated by the planetsplitter program.

   Usage: router [--help | --help-profile | --help-profile-xml |
                           --help-profile-json | --help-profile-perl ]
                 [--dir=<dirname>] [--prefix=<name>]
                 [--profiles=<filename>] [--translations=<filename>]
                 [--exact-nodes-only]
                 [--loggable | --quiet]
                 [--output-html]
                 [--output-gpx-track] [--output-gpx-route]
                 [--output-text] [--output-text-all]
                 [--output-none]
                 [--profile=<name>]
                 [--transport=<transport>]
                 [--shortest | --quickest]
                 --lon1=<longitude> --lat1=<latitude>
                 --lon2=<longitude> --lon2=<latitude>
                 [ ... --lon99=<longitude> --lon99=<latitude>]
                 [--heading=<bearing>]
                 [--highway-<highway>=<preference> ...]
                 [--speed-<highway>=<speed> ...]
                 [--property-<property>=<preference> ...]
                 [--oneway=(0|1)] [--turns=(0|1)]
                 [--weight=<weight>]
                 [--height=<height>] [--width=<width>] [--length=<length>]

   --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/local/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/local/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).

   --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.

   --quiet
          Don't generate any screen output while running (useful for
          running in a script).

   --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.

   --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 motorbike, limited speed)
          + motorbike = Motorbike
          + 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.

   --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.

   Note: In version 1.5 of Routino a slim option has been added and at
   compilation time a separate program called router-slim is created that
   operates in slim mode. In slim mode the database files are read as
   needed rather than being mapped into memory.

   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 (motorbike journey, scenic route, not very fast):

   ./router --dir=data --prefix=gb --transport=motorbike --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 motorbike not using
   motorways or trunk roads and not exceeding 80 km/hr.


filedumper
----------

   This program is used to extract statistics from the database, extract
   particular information for visualisation purposes or for dumping the
   database contents.

   Usage: filedumper [--help]
                     [--dir=<dirname>] [--prefix=<name>]
                     [--statistics]
                     [--visualiser --latmin=<latmin> --latmax=<latmax>
                                   --lonmin=<lonmin> --lonmax=<lonmax>
                                   --data=<data-type>]
                     [--dump [--node=<node> ...]
                             [--segment=<segment> ...]
                             [--way=<way> ...]
                             [--turn-relation=<relation> ...]]
                     [--dump-osm [--no-super]
                                 [--latmin=<latmin> --latmax=<latmax>
                                  --lonmin=<lonmin> --lonmax=<lonmax>]]

   --help
          Prints out the help information.

   --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.

   --statistics
          Prints out statistics about the database files.

   --visualiser
          Selects a data visualiser mode which will output a set of data
          according to the other parameters below.

        --latmin=<latmin> --latmax=<latmax>
                The range of latitudes to print the data for.

        --lonmin=<lonmin> --lonmax=<lonmax>
                The range of longitudes to print the data for.

        --data=<data-type>
                The type of data to output, <data-type> can be selected
                from:

               o junctions = segment count at each junction.
               o super = super-node and super-segments.
               o oneway = oneway segments.
               o highway-* = segments of the specified highway type (e.g.
                 highway-primary to display segments ofprimary roads).
               o transport-* = segments allowing the specified transport
                 type (e.g. transport-foot to display segments accessible
                 on foot).
               o turns = turn restrictions.
               o speed = speed limits.
               o weight = weight limits.
               o height = height limits.
               o width = width limits.
               o length = length limits.

   --dump
          Selects a data dumping mode which allows looking at individual
          items in the databases (specifying 'all' instead of a number
          dumps all of them). More than one of the following parameters
          can be specified on the command line.

        --node=<node>
                Prints the information about the selected node number
                (internal number, not the node id number in the original
                source file).

        --segment=<segment>
                Prints the information about the selected segment number.

        --way=<way>
                Prints the information about the selected way number
                (internal number, not the way id number in the original
                source file).

        --turn-relation=<relation>
                Prints the information about the selected turn relation
                number (internal number, not the relation id number in the
                original source file).

   --osm-dump
          Dumps the contents of the database as an OSM format XML file,
          the whole database will be dumped unless the latitude and
          longitude ranges are specified.

        --no-super
                The super segments will not be output.

        --latmin=<latmin> --latmax=<latmax>
                The range of latitudes to dump the data for.

        --lonmin=<lonmin> --lonmax=<lonmax>
                The range of longitudes to dump the data for.

   Note: In version 1.5 of Routino a slim option has been added and at
   compilation time a separate program called filedumper-slim is created
   that operates in slim mode. In slim mode the database files are read as
   needed rather than being mapped into memory.


tagmodifier
-----------

   This program is used to run the tag transformation process on an OSM
   XML file for test purposes.

   Usage: tagmodifier [--help]
                      [--loggable]
                      [--tagging=<filename>]
                      [<filename.osm>]

   --help
          Prints out the help information.

   --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.

   --tagging=<filename>
          The name of the XML file containing the tagging rules (defaults
          to 'tagging.xml' in the current directory).

   <filename.osm> ...
          Specifies the filename to read data from, by default data is
          read from the standard input.


--------

Copyright 2008-2012 Andrew M. Bishop.
1	Routino : Usage
2	===============
3
4
5	There are four programs that make up this software. The first one takes
6	the planet.osm datafile from OpenStreetMap (or other source of data
7	using the same formats) and converts it into a local database. The
8	second program uses the database to determine an optimum route between
9	two points. The third program allows visualisation of the data and
10	statistics to be extracted. The fourth program is a test program for
11	the tag transformations.
12
13
14	planetsplitter
15	--------------
16
17	This program reads in the OSM format XML file and splits it up to
18	create the database that is used for routing.
19
20	Usage: planetsplitter [--help]
21	[--dir=<dirname>] [--prefix=<name>]
22	[--sort-ram-size=<size>] [--sort-threads=<number>]
23	[--tmpdir=<dirname>]
24	[--tagging=<filename>]
25	[--loggable] [--logtime]
26	[--errorlog[=<name>]]
27	[--parse-only \| --process-only]
28	[--max-iterations=<number>]
29	[--prune-none]
30	[--prune-isolated=<len>]
31	[--prune-short=<len>]
32	[--prune-straight=<len>]
33	[<filename.osm> ...]
34
35	--help
36	Prints out the help information.
37
38	--dir=<dirname>
39	Sets the directory name in which to save the results. Defaults
40	to the current directory.
41
42	--prefix=<name>
43	Sets the filename prefix for the files that are created.
44	Defaults to no prefix.
45
46	--sort-ram-size=<size>
47	Specifies the amount of RAM (in MB) to use for sorting the data.
48	If not specified then 64 MB will be used in slim mode or 256 MB
49	otherwise.
50
51	--sort-threads=<number>
52	The number of threads to use for data sorting (the sorting
53	memory is shared between the threads - too many threads and not
54	enough memory will reduce the performance).
55
56	--tmpdir=<dirname>
57	Specifies the name of the directory to store the temporary disk
58	files. If not specified then it defaults to either the value of
59	the --dir option or the current directory.
60
61	--tagging=<filename>
62	Sets the filename containing the list of tagging rules in XML
63	format for the parsing the input files. If the file doesn't
64	exist then dirname, prefix and "profiles.xml" will be combined
65	and used, if that doesn't exist then the file
66	'/usr/local/share/routino/profiles.xml' (or custom installation
67	location) will be used.
68
69	--loggable
70	Print progress messages that are suitable for logging to a file;
71	normally an incrementing counter is printed which is more
72	suitable for real-time display than logging.
73
74	--logtime
75	Print the elapsed time for each processing step.
76
77	--errorlog[=<name>]
78	Log OSM parsing and processing errors to 'error.log' or the
79	specified file name (the '--dir' and '--prefix' options are
80	applied).
81
82	--parse-only
83	Parse the input files and store them in a temporary file but
84	don't process the data into a routing database.
85
86	--process-only
87	Don't read in any files but process the existing temporary file
88	into the routing database.
89
90	--max-iterations=<number>
91	The maximum number of iterations to use when generating
92	super-nodes and super-segments. Defaults to 5 which is normally
93	enough.
94
95	--prune-none
96	Disable the prune options below, they can be re-enabled by
97	adding them to the command line after this option.
98
99	--prune-isolated=<length>
100	Remove small disconnected groups of segments (defaults to
101	removing groups under 500m).
102
103	--prune-short=<length>
104	Remove short segments (defaults to removing segments up to a
105	maximum length of 5m).
106
107	--prune-straight=<length>
108	Remove nodes in almost straight highways (defaults to removing
109	nodes up to 3m offset from a straight line).
110
111	<filename.osm> ...
112	Specifies the filename(s) to read data from, by default data is
113	read from the standard input.
114
115	Note: In version 1.4 of Routino the --transport, --not-highway and
116	--not-property options have been removed. The same functionality can be
117	achieved by editing the tagging rules file to not output unwanted data.
118
119	Note: In version 1.5 of Routino the --slim option has been removed but
120	at compilation time a separate program called planetsplitter-slim is
121	created that operates in slim mode. In slim mode the temporary files
122	and database files are read as needed rather than being mapped into
123	memory. This allows a database size greater than 2 GB on 32-bit
124	machines or usage with little or no virtual memory (e.g. some virtual
125	machines). The penalty for this is that the program takes about twice
126	as long to run.
127
128	Example usage:
129
130	./planetsplitter --dir=data --prefix=gb great_britain.osm
131
132	This will generate the output files 'data/gb-nodes.mem',
133	'data/gb-segments.mem' and 'data/gb-ways.mem'.
134
135
136	router
137	------
138
139	This program performs the calculation of the optimum routes using the
140	database generated by the planetsplitter program.
141
142	Usage: router [--help \| --help-profile \| --help-profile-xml \|
143	--help-profile-json \| --help-profile-perl ]
144	[--dir=<dirname>] [--prefix=<name>]
145	[--profiles=<filename>] [--translations=<filename>]
146	[--exact-nodes-only]
147	[--loggable \| --quiet]
148	[--output-html]
149	[--output-gpx-track] [--output-gpx-route]
150	[--output-text] [--output-text-all]
151	[--output-none]
152	[--profile=<name>]
153	[--transport=<transport>]
154	[--shortest \| --quickest]
155	--lon1=<longitude> --lat1=<latitude>
156	--lon2=<longitude> --lon2=<latitude>
157	[ ... --lon99=<longitude> --lon99=<latitude>]
158	[--heading=<bearing>]
159	[--highway-<highway>=<preference> ...]
160	[--speed-<highway>=<speed> ...]
161	[--property-<property>=<preference> ...]
162	[--oneway=(0\|1)] [--turns=(0\|1)]
163	[--weight=<weight>]
164	[--height=<height>] [--width=<width>] [--length=<length>]
165
166	--help
167	Prints out the help information.
168
169	--help-profile
170	Prints out the selected transport profile (type, speed limits,
171	highway preferences etc.)
172
173	--help-profile-xml
174	Prints out all the loaded profiles as an XML file in the same
175	format that can be loaded in.
176
177	--help-profile-json
178	Prints out all the loaded profiles in JavaScript Object Notation
179	(JSON) format for use in the interactive webpage.
180
181	--help-profile-perl
182	Prints out all the loaded profiles as a Perl object for use in
183	the router CGI.
184
185	--dir=<dirname>
186	Sets the directory name in which to read the local database.
187	Defaults to the current directory.
188
189	--prefix=<name>
190	Sets the filename prefix for the files in the local database.
191	Defaults to no prefix.
192
193	--profiles=<filename>
194	Sets the filename containing the list of routing profiles in XML
195	format. If the file doesn't exist then dirname, prefix and
196	"profiles.xml" will be combined and used, if that doesn't exist
197	then the file '/usr/local/share/routino/profiles.xml' (or custom
198	installation location) will be used.
199
200	--translations=<filename>
201	Sets the filename containing the list of translations in XML
202	format for the output files. If the file doesn't exist then
203	dirname, prefix and "translations.xml" will be combined and
204	used, if that doesn't exist then the file
205	'/usr/local/share/routino/translations.xml' (or custom
206	installation location) will be used.
207
208	--exact-nodes-only
209	When processing the specified latitude and longitude points only
210	select the nearest node instead of finding the nearest point
211	within a segment (quicker but less accurate unless the points
212	are already near nodes).
213
214	--loggable
215	Print progress messages that are suitable for logging to a file;
216	normally an incrementing counter is printed which is more
217	suitable for real-time display than logging.
218
219	--quiet
220	Don't generate any screen output while running (useful for
221	running in a script).
222
223	--language=<lang>
224	Select the language specified from the file of translations. If
225	this option is not given and the file exists then the first
226	language in the file will be used. If this option is not given
227	and no file exists the compiled-in default language (English)
228	will be used.
229
230	--output-html
231	--output-gpx-track
232	--output-gpx-route
233	--output-text
234	--output-text-all
235	Generate the selected output file formats (HTML, GPX track file,
236	GPX route file, plain text route and/or plain text with all
237	nodes). If no output is specified then all are generated,
238	specifying any automatically disables those not specified.
239
240	--output-none
241	Do not generate any output or read in any translations files.
242
243	--profile=<name>
244	Specifies the name of the profile to use.
245
246	--transport=<transport>
247	Select the type of transport to use, <transport> can be set to:
248
249	+ foot = Foot
250	+ horse = Horse
251	+ wheelchair = Wheelchair
252	+ bicycle = Bicycle
253	+ moped = Moped (Small motorbike, limited speed)
254	+ motorbike = Motorbike
255	+ motorcar = Motorcar
256	+ goods = Goods (Small lorry, van)
257	+ hgv = HGV (Heavy Goods Vehicle - large lorry)
258	+ psv = PSV (Public Service Vehicle - bus, coach)
259
260	Defaults to 'motorcar', this option also selects the default
261	profile information if the '--profile' option is not given and a
262	profile matching the transport name is found.
263
264	--shortest
265	Find the shortest route between the waypoints.
266
267	--quickest
268	Find the quickest route between the waypoints.
269
270	--lon1=<longitude>, --lat1=<latitude>
271	--lon2=<longitude>, --lat2=<latitude>
272	... --lon99=<longitude>, --lat99=<latitude>
273	The location of the waypoints that make up the start, middle and
274	end points of the route. Up to 99 waypoints can be specified and
275	the route will pass through each of the specified ones in
276	sequence. The algorithm will use the closest node or point
277	within a segment that allows the specified traffic type.
278
279	--heading=<bearing>
280	Specifies the initial direction of travel at the start of the
281	route (from the lowest numbered waypoint) as a compass bearing
282	from 0 to 360 degrees.
283
284	--highway-<highway>=<preference>
285	Selects the percentage preference for using each particular type
286	of highway. The value of <highway> can be selected from:
287
288	+ motorway = Motorway
289	+ trunk = Trunk
290	+ primary = Primary
291	+ secondary = Secondary
292	+ tertiary = Tertiary
293	+ unclassified = Unclassified
294	+ residential = Residential
295	+ service = Service
296	+ track = Track
297	+ cycleway = Cycleway
298	+ path = Path
299	+ steps = Steps
300	+ ferry = Ferry
301
302	Default value depends on the profile selected by the --transport
303	option.
304
305	--speed-<highway>=<speed>
306	Selects the speed limit in km/hour for each type of highway.
307	Default value depends on the profile selected by the --transport
308	option.
309
310	--property-<property>=<preference>
311	Selects the percentage preference for using each particular
312	highway property The value of <property> can be selected from:
313
314	+ paved = Paved (suitable for normal wheels)
315	+ multilane = Multiple lanes
316	+ bridge = Bridge
317	+ tunnel = Tunnel
318	+ footroute = A route marked for foot travel
319	+ bicycleroute = A route marked for bicycle travel
320
321	Default value depends on the profile selected by the --transport
322	option.
323
324	--oneway=[0\|1]
325	Selects if the direction of oneway streets are to be obeyed
326	(useful to not obey them when walking). Default value depends on
327	the profile selected by the --transport option.
328
329	--turns=[0\|1]
330	Selects if turn restrictions are to be obeyed (useful to not
331	obey them when walking). Default value depends on the profile
332	selected by the --transport option.
333
334	--weight=<weight>
335	Specifies the weight of the mode of transport in tonnes; ensures
336	that the weight limit on the highway is not exceeded. Default
337	value depends on the profile selected by the --transport option.
338
339	--height=<height>
340	Specifies the height of the mode of transport in metres; ensures
341	that the height limit on the highway is not exceeded. Default
342	value depends on the profile selected by the --transport option.
343
344	--width=<width>
345	Specifies the width of the mode of transport in metres; ensures
346	that the width limit on the highway is not exceeded. Default
347	value depends on the profile selected by the --transport option.
348
349	--length=<length>
350	Specifies the length of the mode of transport in metres; ensures
351	that the length limit on the highway is not exceeded. Default
352	value depends on the profile selected by the --transport option.
353
354	Note: In version 1.5 of Routino a slim option has been added and at
355	compilation time a separate program called router-slim is created that
356	operates in slim mode. In slim mode the database files are read as
357	needed rather than being mapped into memory.
358
359	The meaning of the <preference> parameter in the command line options
360	is slightly different for the highway preferences and the property
361	preferences. For the highway preference consider the choice between two
362	possible highways between the start and finish when looking for the
363	shortest route. If highway A has a preference of 100% and highway B has
364	a preference of 90% then highway A will be chosen even if it is up to
365	11% longer (100/90 = 111%). For the highway properties each highway
366	either has a particular property or not. If the preference for the
367	property is 60% then a highway with the property has a preference of
368	77% (sqrt(60%)) and one without has a preference of 63%
369	(sqrt(100-60%)). A highway with the property will be chosen even if it
370	is up to 22% longer than one without the property (77/63 = 122%). The
371	overall preference for each highway segment is the product of the
372	preference for the highway type and all of the preferences for the
373	highway properties.
374
375	Example usage (motorbike journey, scenic route, not very fast):
376
377	./router --dir=data --prefix=gb --transport=motorbike --highway-motorway=0 \
378	--highway-trunk=0 --speed-primary=80 --speed-secondary=80 --quickest
379
380	This will use the files 'data/gb-nodes.mem', 'data/gb-segments.mem' and
381	'data/gb-ways.mem' to find the quickest route by motorbike not using
382	motorways or trunk roads and not exceeding 80 km/hr.
383
384
385	filedumper
386	----------
387
388	This program is used to extract statistics from the database, extract
389	particular information for visualisation purposes or for dumping the
390	database contents.
391
392	Usage: filedumper [--help]
393	[--dir=<dirname>] [--prefix=<name>]
394	[--statistics]
395	[--visualiser --latmin=<latmin> --latmax=<latmax>
396	--lonmin=<lonmin> --lonmax=<lonmax>
397	--data=<data-type>]
398	[--dump [--node=<node> ...]
399	[--segment=<segment> ...]
400	[--way=<way> ...]
401	[--turn-relation=<relation> ...]]
402	[--dump-osm [--no-super]
403	[--latmin=<latmin> --latmax=<latmax>
404	--lonmin=<lonmin> --lonmax=<lonmax>]]
405
406	--help
407	Prints out the help information.
408
409	--dir=<dirname>
410	Sets the directory name in which to read the local database.
411	Defaults to the current directory.
412
413	--prefix=<name>
414	Sets the filename prefix for the files in the local database.
415
416	--statistics
417	Prints out statistics about the database files.
418
419	--visualiser
420	Selects a data visualiser mode which will output a set of data
421	according to the other parameters below.
422
423	--latmin=<latmin> --latmax=<latmax>
424	The range of latitudes to print the data for.
425
426	--lonmin=<lonmin> --lonmax=<lonmax>
427	The range of longitudes to print the data for.
428
429	--data=<data-type>
430	The type of data to output, <data-type> can be selected
431	from:
432
433	o junctions = segment count at each junction.
434	o super = super-node and super-segments.
435	o oneway = oneway segments.
436	o highway-* = segments of the specified highway type (e.g.
437	highway-primary to display segments ofprimary roads).
438	o transport-* = segments allowing the specified transport
439	type (e.g. transport-foot to display segments accessible
440	on foot).
441	o turns = turn restrictions.
442	o speed = speed limits.
443	o weight = weight limits.
444	o height = height limits.
445	o width = width limits.
446	o length = length limits.
447
448	--dump
449	Selects a data dumping mode which allows looking at individual
450	items in the databases (specifying 'all' instead of a number
451	dumps all of them). More than one of the following parameters
452	can be specified on the command line.
453
454	--node=<node>
455	Prints the information about the selected node number
456	(internal number, not the node id number in the original
457	source file).
458
459	--segment=<segment>
460	Prints the information about the selected segment number.
461
462	--way=<way>
463	Prints the information about the selected way number
464	(internal number, not the way id number in the original
465	source file).
466
467	--turn-relation=<relation>
468	Prints the information about the selected turn relation
469	number (internal number, not the relation id number in the
470	original source file).
471
472	--osm-dump
473	Dumps the contents of the database as an OSM format XML file,
474	the whole database will be dumped unless the latitude and
475	longitude ranges are specified.
476
477	--no-super
478	The super segments will not be output.
479
480	--latmin=<latmin> --latmax=<latmax>
481	The range of latitudes to dump the data for.
482
483	--lonmin=<lonmin> --lonmax=<lonmax>
484	The range of longitudes to dump the data for.
485
486	Note: In version 1.5 of Routino a slim option has been added and at
487	compilation time a separate program called filedumper-slim is created
488	that operates in slim mode. In slim mode the database files are read as
489	needed rather than being mapped into memory.
490
491
492	tagmodifier
493	-----------
494
495	This program is used to run the tag transformation process on an OSM
496	XML file for test purposes.
497
498	Usage: tagmodifier [--help]
499	[--loggable]
500	[--tagging=<filename>]
501	[<filename.osm>]
502
503	--help
504	Prints out the help information.
505
506	--loggable
507	Print progress messages that are suitable for logging to a file;
508	normally an incrementing counter is printed which is more
509	suitable for real-time display than logging.
510
511	--tagging=<filename>
512	The name of the XML file containing the tagging rules (defaults
513	to 'tagging.xml' in the current directory).
514
515	<filename.osm> ...
516	Specifies the filename to read data from, by default data is
517	read from the standard input.
518
519
520	--------
521
522	Copyright 2008-2012 Andrew M. Bishop.