Routino SVN Repository Browser

Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino

ViewVC logotype

Annotation of /trunk/doc/USAGE.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 420 - (hide annotations) (download)
Sun May 30 18:25:06 2010 UTC (14 years, 9 months ago) by amb
File MIME type: text/plain
File size: 16484 byte(s)
Add the planetsplitter tagging rules option (and remove the unnecessary options
that it replaces), add the filedumper OSM dump option and add the tagmodifier
program.

1 amb 381 Routino : Usage
2     ===============
3 amb 152
4    
5 amb 420 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 amb 191 second program uses the database to determine an optimum route between
9     two points. The third program allows visualisation of the data and
10 amb 420 statistics to be extracted. The fourth program is a test program for
11     the tag transformations.
12 amb 152
13     planetsplitter
14 amb 318 --------------
15 amb 152
16 amb 420 This program reads in the OSM format XML file and splits it up to
17     create the database that is used for routing.
18    
19 amb 381 Usage: planetsplitter [--help]
20     [--dir=<dirname>] [--prefix=<name>]
21     [--slim] [--sort-ram-size=<size>]
22     [--tmpdir=<dirname>]
23     [--parse-only | --process-only]
24     [--max-iterations=<number>]
25 amb 420 [--tagging=<filename>]
26 amb 381 [<filename.osm> ...]
27 amb 152
28     --help
29     Prints out the help information.
30    
31 amb 381 --dir=<dirname>
32 amb 152 Sets the directory name in which to save the results. Defaults
33     to the current directory.
34    
35     --prefix=<name>
36     Sets the filename prefix for the files that are created.
37     Defaults to no prefix.
38    
39 amb 288 --slim
40     Selects a mode of operation that uses less memory and will
41     therefore work where virtual memory is very limited or
42     unavailable. Selecting this option will cause raw data to be
43     held in disk files with only indexes in RAM. Not using this
44     option will still use disk files but only for sequential access
45     and the files are memory mapped for random access.
46    
47 amb 381 --sort-ram-size=<size>
48     Specifies the amount of RAM (in MB) to use for sorting the data.
49     If not specified then 64 MB will be used if the '--slim' option
50     is specified or 256 MB otherwise.
51    
52     --tmpdir=<dirname>
53 amb 288 Specifies the name of the directory to store the temporary disk
54     files. If not specified then it defaults to either the value of
55     the --dir option or the current directory.
56    
57 amb 381 --parse-only
58     Parse the input files and store them in a temporary file but
59     don't process the data into a routing database.
60    
61     --process-only
62     Don't read in any files but process the existing temporary file
63     into the routing database.
64    
65 amb 318 --max-iterations=<number>
66     The maximum number of iterations to use when generating
67     super-nodes and super-segments. Defaults to 10 which is normally
68     enough.
69    
70 amb 420 --tagging=<filename>
71     The name of the XML file containing the tagging rules (defaults
72     to 'tagging.xml' with '--dirname' and '--prefix' options).
73 amb 318
74 amb 381 <filename.osm> ...
75     Specifies the filename(s) to read data from, by default data is
76     read from the standard input.
77    
78 amb 420 Note: In version 1.4 of Routino the --transport, --not-highway and
79     --not-property options have been removed. The same functionality can be
80     achieved by editing the tagging rules file to not output unwwanted data.
81    
82 amb 152 Example usage:
83 amb 381
84 amb 420 ./planetsplitter --dir=data --prefix=gb great_britain.osm
85 amb 180
86 amb 152 This will generate the output files 'data/gb-nodes.mem',
87     'data/gb-segments.mem' and 'data/gb-ways.mem'.
88    
89 amb 318
90 amb 152 router
91 amb 318 ------
92 amb 152
93 amb 420 This program performs the calculation of the optimum routes using the
94     database generated by the planetsplitter program.
95    
96 amb 381 Usage: router [--help | --help-profile | --help-profile-xml |
97     --help-profile-json | --help-profile-perl ]
98     [--dir=<dirname>] [--prefix=<name>]
99     [--profiles=<filename>] [--translations=<filename>]
100     [--exact-nodes-only]
101     [--quiet]
102     [--output-html]
103     [--output-gpx-track] [--output-gpx-route]
104     [--output-text] [--output-text-all]
105     [--output-none]
106     [--profile=<name>]
107     [--transport=<transport>]
108     [--shortest | --quickest]
109     --lon1=<longitude> --lat1=<latitude>
110     --lon2=<longitude> --lon2=<latitude>
111     [ ... --lon99=<longitude> --lon99=<latitude>]
112     [--highway-<highway>=<preference> ...]
113     [--speed-<highway>=<speed> ...]
114     [--property-<property>=<preference> ...]
115     [--oneway=(0|1)]
116     [--weight=<weight>]
117     [--height=<height>] [--width=<width>] [--length=<length>]
118 amb 152
119     --help
120     Prints out the help information.
121    
122     --help-profile
123     Prints out the selected transport profile (type, speed limits,
124     highway preferences etc.)
125    
126 amb 381 --help-profile-xml
127     Prints out all the loaded profiles as an XML file in the same
128     format that can be loaded in.
129 amb 152
130 amb 381 --help-profile-json
131     Prints out all the loaded profiles in JavaScript Object Notation
132     (JSON) format for use in the interactive webpage.
133 amb 152
134 amb 381 --help-profile-perl
135     Prints out all the loaded profiles as a Perl object for use in
136     the router CGI.
137    
138     --dir=<dirname>
139 amb 191 Sets the directory name in which to read the local database.
140     Defaults to the current directory.
141 amb 152
142     --prefix=<name>
143 amb 191 Sets the filename prefix for the files in the local database.
144 amb 152 Defaults to no prefix.
145    
146 amb 381 --profiles=<filename>
147     Sets the filename containing the list of profiles in XML format.
148     If the file doesn't exist then dirname, prefix and
149     "profiles.xml" will be combined and used, if that doesn't exist
150     then the command line must contain all relevant profile
151     information.
152 amb 152
153 amb 381 --translations=<filename>
154     Sets the filename containing the list of translations in XML
155     format for the output files. If the file doesn't exist then
156     dirname, prefix and "translations.xml" will be combined and
157     used, if that doesn't exist then no file will be read and no
158     language can be selected.
159 amb 152
160 amb 318 --exact-nodes-only
161     When processing the specified latitude and longitude points only
162     select the nearest node instead of finding the nearest point
163 amb 381 within a segment (quicker but less accurate unless the points
164     are already near nodes).
165 amb 318
166 amb 152 --quiet
167     Don't generate any screen output while running (useful for
168     running in a script).
169    
170 amb 381 --language=<lang>
171     Select the language specified from the file of translations. If
172     this option is not given and the file exists then the first
173     language in the file will be used. If this option is not given
174     and no file exists the compiled-in default language (English)
175     will be used.
176    
177     --output-html
178     --output-gpx-track
179     --output-gpx-route
180     --output-text
181     --output-text-all
182     Generate the selected output file formats (HTML, GPX track file,
183     GPX route file, plain text route and/or plain text with all
184     nodes). If no output is specified then all are generated,
185     specifying any automatically disables those not specified.
186    
187     --output-none
188     Do not generate any output or read in any translations files.
189    
190     --profile=<name>
191     Specifies the name of the profile to use.
192    
193 amb 152 --transport=<transport>
194 amb 191 Select the type of transport to use, <transport> can be set to:
195 amb 318
196     + foot = Foot
197     + horse = Horse
198     + wheelchair = Wheelchair
199     + bicycle = Bicycle
200     + moped = Moped (Small motorbike, limited speed)
201     + motorbike = Motorbike
202     + motorcar = Motorcar
203     + goods = Goods (Small lorry, van)
204     + hgv = HGV (Heavy Goods Vehicle - large lorry)
205     + psv = PSV (Public Service Vehicle - bus, coach)
206    
207     Defaults to 'motorcar', this option also selects the default
208 amb 381 profile information if the '--profile' option is not given and a
209     profile matching the transport name is found.
210 amb 152
211 amb 381 --shortest
212     Find the shortest route between the waypoints.
213    
214     --quickest
215     Find the quickest route between the waypoints.
216    
217     --lon1=<longitude>, --lat1=<latitude>
218     --lon2=<longitude>, --lat2=<latitude>
219     ... --lon99=<longitude>, --lat99=<latitude>
220     The location of the waypoints that make up the start, middle and
221     end points of the route. Up to 99 waypoints can be specified and
222     the route will pass through each of the specified ones in
223     sequence. The algorithm will use the closest node or point
224     within a segment that allows the specified traffic type.
225    
226 amb 180 --highway-<highway>=<preference>
227     Selects the percentage preference for using each particular type
228 amb 318 of highway. The value of <highway> can be selected from:
229 amb 152
230 amb 318 + motorway = Motorway
231     + trunk = Trunk
232     + primary = Primary
233     + secondary = Secondary
234     + tertiary = Tertiary
235     + unclassified = Unclassified
236     + residential = Residential
237     + service = Service
238     + track = Track
239     + cycleway = Cycleway
240     + path = Path
241     + steps = Steps
242    
243     Default value depends on the profile selected by the --transport
244     option.
245    
246 amb 152 --speed-<highway>=<speed>
247 amb 191 Selects the speed limit in km/hour for each type of highway.
248     Default value depends on the profile selected by the --transport
249     option.
250 amb 152
251 amb 318 --property-<property>=<preference>
252     Selects the percentage preference for using each particular
253     highway property The value of <property> can be selected from:
254    
255     + paved = Paved (suitable for normal wheels)
256     + multilane = Multiple lanes
257     + bridge = Bridge
258     + tunnel = Tunnel
259    
260     Default value depends on the profile selected by the --transport
261     option.
262    
263 amb 152 --oneway=[0|1]
264     Selects if the direction of oneway streets are to be obeyed
265     (useful to not obey them when walking). Default value depends on
266     the profile selected by the --transport option.
267    
268     --weight=<weight>
269 amb 318 Specifies the weight of the mode of transport in tonnes; ensures
270 amb 191 that the weight limit on the highway is not exceeded. Default
271     value depends on the profile selected by the --transport option.
272 amb 152
273     --height=<height>
274 amb 318 Specifies the height of the mode of transport in metres; ensures
275 amb 191 that the height limit on the highway is not exceeded. Default
276     value depends on the profile selected by the --transport option.
277 amb 152
278     --width=<width>
279 amb 318 Specifies the width of the mode of transport in metres; ensures
280 amb 191 that the width limit on the highway is not exceeded. Default
281     value depends on the profile selected by the --transport option.
282 amb 152
283     --length=<length>
284 amb 318 Specifies the length of the mode of transport in metres; ensures
285 amb 191 that the length limit on the highway is not exceeded. Default
286     value depends on the profile selected by the --transport option.
287 amb 152
288 amb 318 The meaning of the <preference> parameter in the command line options
289     is slightly different for the highway preferences and the property
290     preferences. For the highway preference consider the choice between two
291     possible highways between the start and finish when looking for the
292     shortest route. If highway A has a preference of 100% and highway B has
293     a preference of 90% then highway A will be chosen even if it is up to
294     11% longer (100/90 = 111%). For the highway properties each highway
295     either has a particular property or not. If the preference for highways
296     with the property is 60% then the preference for highways without the
297     property is 40%. The overall preference for the highway is the product
298     of the highway preference and the preference for highways with (or
299     without) each property that the highway has (or doesn't have).
300    
301 amb 152 Example usage (motorbike journey, scenic route, not very fast):
302 amb 180
303 amb 152 ./router --dir=data --prefix=gb --transport=motorbike --highway-motorway=0 \
304     --highway-trunk=0 --speed-primary=80 --speed-secondary=80 --quickest
305    
306     This will use the files 'data/gb-nodes.mem', 'data/gb-segments.mem' and
307     'data/gb-ways.mem' to find the quickest route by motorbike not using
308     motorways or trunk roads and not exceeding 80 km/hr.
309    
310 amb 180
311 amb 191 filedumper
312 amb 318 ----------
313 amb 152
314 amb 420 This program is used to extract statistics from the database, extract
315     particular information for visualisation purposes or for dumping the
316     database contents.
317    
318 amb 381 Usage: filedumper [--help]
319     [--dir=<dirname>] [--prefix=<name>]
320     [--statistics]
321     [--visualiser --latmin=<latmin> --latmax=<latmax>
322     --lonmin=<lonmin> --lonmax=<lonmax>
323     --data=<data-type>]
324     [--dump [--node=<node> ...]
325     [--segment=<segment> ...]
326     [--way=<way> ...]]
327 amb 420 [--dump-osm [--no-super]
328     [--latmin=<latmin> --latmax=<latmax>
329     --lonmin=<lonmin> --lonmax=<lonmax>]]
330 amb 152
331 amb 191 --help
332     Prints out the help information.
333 amb 152
334 amb 381 --dir=<dirname>
335 amb 191 Sets the directory name in which to read the local database.
336     Defaults to the current directory.
337 amb 152
338 amb 191 --prefix=<name>
339     Sets the filename prefix for the files in the local database.
340 amb 180
341 amb 191 --statistics
342     Prints out statistics about the database files.
343 amb 152
344 amb 191 --visualiser
345     Selects a data visualiser mode which will output a set of data
346     according to the other parameters below.
347 amb 152
348 amb 191 --latmin=<latmin> --latmax=<latmax>
349     The range of latitudes to print the data for.
350 amb 152
351 amb 191 --lonmin=<lonmin> --lonmax=<lonmax>
352     The range of longitudes to print the data for.
353 amb 155
354 amb 191 --data=<data-type>
355     The type of data to output, <data-type> can be selected
356     from:
357 amb 381
358 amb 191 o junctions = segment count at each junction.
359     o super = super-node and super-segments.
360     o oneway = oneway segments.
361     o speed = speed limits.
362     o weight = weight limits.
363     o height = height limits.
364     o width = width limits.
365     o length = length limits.
366 amb 155
367 amb 288 --dump
368     Selects a data dumping mode which allows looking at individual
369 amb 381 items in the databases (specifying 'all' instead of a number
370     dumps all of them).
371 amb 191
372 amb 288 --node=<node>
373     Prints the information about the selected node number
374 amb 318 (internal number, not the node id number in the original
375 amb 288 source file).
376    
377     --segment=<segment>
378     Prints the information about the selected segment number.
379    
380     --way=<way>
381 amb 318 Prints the information about the selected way number
382     (internal number, not the way id number in the original
383     source file).
384 amb 288
385 amb 420 --osm-dump
386     Dumps the contents of the database as an OSM format XML file,
387     the whole database will be dumped unless the latitude and
388     longitude ranges are specified.
389 amb 288
390 amb 420 --no-super
391     The super segments will not be output.
392    
393     --latmin=<latmin> --latmax=<latmax>
394     The range of latitudes to dump the data for.
395    
396     --lonmin=<lonmin> --lonmax=<lonmax>
397     The range of longitudes to dump the data for.
398    
399     tagmodifier
400     -----------
401    
402     This program is used to run the tag transformation process on an OSM
403     XML file for test purposes.
404    
405     Usage: tagmodifier [--help]
406     [--tagging=<filename>]
407     [<filename.osm>]
408    
409     --help
410     Prints out the help information.
411    
412     --tagging=<filename>
413     The name of the XML file containing the tagging rules (defaults
414     to 'tagging.xml' in the current directory).
415    
416     <filename.osm> ...
417     Specifies the filename to read data from, by default data is
418     read from the standard input.
419     __________________________________________________________________
420    
421 amb 152 --------
422    
423 amb 381 Copyright 2008-2010 Andrew M. Bishop.

Properties

Name Value
cvs:description Description of program usage.