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/html/usage.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1391 - (hide annotations) (download) (as text)
Mon Jun 10 18:42:44 2013 UTC (11 years, 9 months ago) by amb
File MIME type: text/html
File size: 27908 byte(s)
Fix typo in documentation.

1 amb 577 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2     <HTML>
3    
4 amb 1257 <HEAD>
5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6    
7     <title>Routino : Usage</title>
8    
9 amb 577 <!--
10 amb 584 Routino documentation - usage
11 amb 577
12     Part of the Routino routing software.
13    
14 amb 1248 This file Copyright 2008-2013 Andrew M. Bishop
15 amb 577
16     This program is free software: you can redistribute it and/or modify
17     it under the terms of the GNU Affero General Public License as published by
18     the Free Software Foundation, either version 3 of the License, or
19     (at your option) any later version.
20    
21     This program is distributed in the hope that it will be useful,
22     but WITHOUT ANY WARRANTY; without even the implied warranty of
23     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24     GNU Affero General Public License for more details.
25    
26     You should have received a copy of the GNU Affero General Public License
27     along with this program. If not, see http://www.gnu.org/licenses/.
28     -->
29    
30 amb 1257 <link href="style.css" type="text/css" rel="stylesheet">
31 amb 577 </HEAD>
32    
33     <BODY>
34    
35     <!-- Header Start -->
36    
37     <div class="header" align="center">
38    
39     <h1>Routino : Usage</h1>
40    
41     <hr>
42     </div>
43    
44     <!-- Header End -->
45    
46     <!-- Content Start -->
47    
48     <div class="content">
49    
50     <h2><a name="H_1_1"></a>Program Usage</h2>
51    
52 amb 1149 There are five programs that make up this software. The first one takes the
53 amb 577 planet.osm datafile from OpenStreetMap (or other source of data using the same
54     formats) and converts it into a local database. The second program uses the
55     database to determine an optimum route between two points. The third program
56     allows visualisation of the data and statistics to be extracted. The fourth
57 amb 1149 program allows dumping the raw parsed data for test purposes and the fifth is a
58     test program for the tag transformations.
59 amb 577
60     <h3><a name="H_1_1_1"></a>planetsplitter</h3>
61    
62     This program reads in the OSM format XML file and splits it up to create the
63     database that is used for routing.
64    
65     <pre class="boxed">
66     Usage: planetsplitter [--help]
67     [--dir=&lt;dirname&gt;] [--prefix=&lt;name&gt;]
68 amb 991 [--sort-ram-size=&lt;size&gt;] [--sort-threads=&lt;number&gt;]
69 amb 577 [--tmpdir=&lt;dirname&gt;]
70 amb 953 [--tagging=&lt;filename&gt;]
71 amb 982 [--loggable] [--logtime]
72     [--errorlog[=&lt;name&gt;]]
73 amb 577 [--parse-only | --process-only]
74 amb 1167 [--append] [--keep] [--changes]
75 amb 577 [--max-iterations=&lt;number&gt;]
76 amb 975 [--prune-none]
77     [--prune-isolated=&lt;len&gt;]
78     [--prune-short=&lt;len&gt;]
79     [--prune-straight=&lt;len&gt;]
80 amb 1197 [&lt;filename.osm&gt; ... | &lt;filename.osc&gt; ...
81 amb 1227 | &lt;filename.pbf&gt; ...
82     | &lt;filename.o5m&gt; ... | &lt;filename.o5c&gt; ...
83     | &lt;filename.(osm|osc|o5m|o5c).bz2&gt; ...
84     | &lt;filename.(osm|osc|o5m|o5c).gz&gt; ...]
85 amb 577 </pre>
86    
87     <dl>
88     <dt>--help
89     <dd>Prints out the help information.
90     <dt>--dir=&lt;dirname&gt;
91     <dd>Sets the directory name in which to save the results.
92     Defaults to the current directory.
93     <dt>--prefix=&lt;name&gt;
94     <dd>Sets the filename prefix for the files that are created.
95     Defaults to no prefix.
96     <dt>--sort-ram-size=&lt;size&gt;
97     <dd>Specifies the amount of RAM (in MB) to use for sorting the data. If not
98 amb 585 specified then 64 MB will be used in slim mode or 256 MB otherwise.
99 amb 991 <dt>--sort-threads=&lt;number&gt;
100     <dd>The number of threads to use for data sorting (the sorting memory is
101 amb 1023 shared between the threads - too many threads and not enough memory will
102     reduce the performance).
103 amb 577 <dt>--tmpdir=&lt;dirname&gt;
104     <dd>Specifies the name of the directory to store the temporary disk files. If
105     not specified then it defaults to either the value of the --dir option or the
106     current directory.
107 amb 953 <dt>--tagging=&lt;filename&gt;
108     <dd>Sets the filename containing the list of tagging rules in XML format for
109     the parsing the input files. If the file doesn't exist then dirname, prefix
110     and "profiles.xml" will be combined and used, if that doesn't exist then the
111     file '/usr/local/share/routino/profiles.xml' (or custom installation
112     location) will be used.
113 amb 586 <dt>--loggable
114     <dd>Print progress messages that are suitable for logging to a file; normally
115 amb 737 an incrementing counter is printed which is more suitable for real-time
116 amb 586 display than logging.
117 amb 982 <dt>--logtime
118     <dd>Print the elapsed time for each processing step.
119 amb 810 <dt>--errorlog[=&lt;name&gt;]
120     <dd>Log OSM parsing and processing errors to 'error.log' or the specified file
121 amb 1120 name (the '--dir' and '--prefix' options are applied). If the --append
122     option is used then the existing log file will be appended, otherwise a new
123     one will be created.
124 amb 953 <dt>--parse-only
125 amb 1120 <dd>Parse the input files and store the data in intermediate files but don't
126     process the data into a routing database. This option must be used with the
127     --append option for all except the first file.
128 amb 953 <dt>--process-only
129 amb 1120 <dd>Don't read in any files but process the existing intermediate files
130     created by using the --parse-only option.
131     <dt>--append
132     <dd>Parse the input file and append the result to the existing intermediate
133 amb 1140 files; the appended file can be either an OSM file or an OSC change file.
134 amb 1167 <dt>--keep
135 amb 1136 <dd>Store a set of intermediate files after parsing the OSM files, sorting and
136 amb 1157 removing duplicates; this allows appending an OSC file and re-processing
137     later.
138 amb 1140 <dt>--changes
139     <dd>This option indicates that the data being processed contains one or more
140     OSC (OSM changes) files, they must be applied in time sequence if more than
141     one is used. This option implies --append when parsing data files and
142 amb 1167 --keep when processing data.
143 amb 577 <dt>--max-iterations=&lt;number&gt;
144     <dd>The maximum number of iterations to use when generating super-nodes and
145 amb 861 super-segments. Defaults to 5 which is normally enough.
146 amb 975 <dt>--prune-none
147     <dd>Disable the prune options below, they can be re-enabled by adding them to
148     the command line after this option.
149     <dt>--prune-isolated=&lt;length&gt;
150 amb 1117 <dd>Remove the access permissions for a transport type from small disconnected
151 amb 1391 groups of segments and remove the segments if they end up with no access
152 amb 1117 permission (defaults to removing groups under 500m).
153 amb 975 <dt>--prune-short=&lt;length&gt;
154     <dd>Remove short segments (defaults to removing segments up to a maximum
155     length of 5m).
156     <dt>--prune-straight=&lt;length&gt;
157     <dd>Remove nodes in almost straight highways (defaults to removing nodes up to
158     3m offset from a straight line).
159 amb 1227 <dt>&lt;filename.osm&gt;, &lt;filename.osc&gt;, &lt;filename.pbf&gt;, &lt;filename.o5m&gt;, &lt;filename.o5c&gt;
160 amb 1224 <dd>Specifies the filename(s) to read data from. Filenames ending '.pbf' will
161 amb 1227 be read as PBF, filenames ending in '.o5m' or '.o5c' will be read as
162     O5M/O5C, otherwise as XML. Filenames ending '.bz2' will be bzip2
163 amb 1224 uncompressed (if bzip2 support compiled in). Filenames ending '.gz' will be
164     gzip uncompressed (if gzip support compiled in).
165 amb 577 </dl>
166    
167     <p>
168     <i>Note: In version 1.4 of Routino the --transport, --not-highway and
169     --not-property options have been removed. The same functionality can be
170 amb 737 achieved by editing the tagging rules file to not output unwanted data.</i>
171 amb 577
172     <p>
173 amb 585 <i>Note: In version 1.5 of Routino the --slim option has been removed but at
174     compilation time a separate program called <em>planetsplitter-slim</em> is
175     created that operates in slim mode. In slim mode the temporary files and
176     database files are read as needed rather than being mapped into memory. This
177     allows a database size greater than 2 GB on 32-bit machines or usage with little
178     or no virtual memory (e.g. some virtual machines). The penalty for this is that
179 amb 953 the program takes about twice as long to run.</i>
180 amb 585
181     <p>
182 amb 1224 <i>Note: In version 2.5 of Routino the ability to read data from the standard
183     input has been removed. This is because there is now the ability to read
184     compressed files (bzip2 and gzip) and PBF files directly. Also using standard
185     input the file type cannot be auto-detected from the filename.</i>
186    
187     <p>
188 amb 1120 Example usage 1:
189 amb 577
190     <pre class="boxed">
191 amb 1120 planetsplitter --dir=data --prefix=gb great_britain.osm
192 amb 577 </pre>
193    
194     This will generate the output files 'data/gb-nodes.mem', 'data/gb-segments.mem'
195 amb 1120 and 'data/gb-ways.mem'. Multiple filenames can be specified on the command
196     line and they will all be read in, combined and processed together.
197 amb 577
198 amb 1120 <p>
199     Example usage 2:
200 amb 577
201 amb 1120 <pre class="boxed">
202     planetsplitter --dir=data --prefix=gb --parse-only great_britain_part1.osm
203     planetsplitter --dir=data --prefix=gb --parse-only --append great_britain_part2.osm
204     planetsplitter --dir=data --prefix=gb --parse-only --append ...
205     planetsplitter --dir=data --prefix=gb --process-only
206     </pre>
207    
208     This will generate the same output files as the first example but parsing the
209     input files is performed separately from the data processing. The first file
210     read in must not use the --append option but the later ones must.
211    
212 amb 1140 <p>
213     Example usage 3:
214 amb 1120
215 amb 1140 <pre class="boxed">
216 amb 1224 planetsplitter --dir=data --prefix=gb --keep great_britain.osm
217 amb 1140
218     planetsplitter --dir=data --prefix=gb --changes great_britain.osc
219     </pre>
220    
221     This will generate the same output files as the first example. The first
222     command will process the complete file and keep some intermediate data for
223     later. The second command will apply a set of changes to the stored
224     intermediate data and keep the updated intermediate files for repeating this
225     step later with more change data.
226     <p>
227     The parsing and processing can be split into multiple commands as it was in
228 amb 1167 example 2 with the --keep option used with --process-only for the initial OSM
229     file(s) and the --changes option used with --parse-only or --process-only for
230     every OSC file.
231 amb 1140
232    
233 amb 577 <h3><a name="H_1_1_2"></a>router</h3>
234    
235     This program performs the calculation of the optimum routes using the database
236     generated by the planetsplitter program.
237    
238     <pre class="boxed">
239     Usage: router [--help | --help-profile | --help-profile-xml |
240     --help-profile-json | --help-profile-perl ]
241     [--dir=&lt;dirname&gt;] [--prefix=&lt;name&gt;]
242     [--profiles=&lt;filename&gt;] [--translations=&lt;filename&gt;]
243     [--exact-nodes-only]
244 amb 586 [--loggable | --quiet]
245 amb 577 [--output-html]
246     [--output-gpx-track] [--output-gpx-route]
247     [--output-text] [--output-text-all]
248     [--output-none]
249     [--profile=&lt;name&gt;]
250     [--transport=&lt;transport&gt;]
251     [--shortest | --quickest]
252     --lon1=&lt;longitude&gt; --lat1=&lt;latitude&gt;
253     --lon2=&lt;longitude&gt; --lon2=&lt;latitude&gt;
254     [ ... --lon99=&lt;longitude&gt; --lon99=&lt;latitude&gt;]
255 amb 675 [--heading=&lt;bearing&gt;]
256 amb 577 [--highway-&lt;highway&gt;=&lt;preference&gt; ...]
257     [--speed-&lt;highway&gt;=&lt;speed&gt; ...]
258     [--property-&lt;property&gt;=&lt;preference&gt; ...]
259 amb 622 [--oneway=(0|1)] [--turns=(0|1)]
260 amb 577 [--weight=&lt;weight&gt;]
261     [--height=&lt;height&gt;] [--width=&lt;width&gt;] [--length=&lt;length&gt;]
262     </pre>
263    
264     <dl>
265     <dt>--help
266     <dd>Prints out the help information.
267     <dt>--help-profile
268     <dd>Prints out the selected transport profile (type, speed limits, highway
269     preferences etc.)
270     <dt>--help-profile-xml
271     <dd>Prints out all the loaded profiles as an XML file in the same format that
272     can be loaded in.
273     <dt>--help-profile-json
274     <dd>Prints out all the loaded profiles in JavaScript Object Notation (JSON)
275     format for use in the interactive webpage.
276     <dt>--help-profile-perl
277     <dd>Prints out all the loaded profiles as a Perl object for use in the router
278     CGI.
279     <dt>--dir=&lt;dirname&gt;
280     <dd>Sets the directory name in which to read the local database.
281     Defaults to the current directory.
282     <dt>--prefix=&lt;name&gt;
283     <dd>Sets the filename prefix for the files in the local database.
284     Defaults to no prefix.
285     <dt>--profiles=&lt;filename&gt;
286 amb 585 <dd>Sets the filename containing the list of routing profiles in XML format.
287     If the file doesn't exist then dirname, prefix and "profiles.xml" will be
288     combined and used, if that doesn't exist then the file
289     '/usr/local/share/routino/profiles.xml' (or custom installation location)
290     will be used.
291 amb 577 <dt>--translations=&lt;filename&gt;
292     <dd>Sets the filename containing the list of translations in XML format for
293     the output files. If the file doesn't exist then dirname, prefix and
294 amb 585 "translations.xml" will be combined and used, if that doesn't exist then the
295     file '/usr/local/share/routino/translations.xml' (or custom installation
296     location) will be used.
297 amb 577 <dt>--exact-nodes-only
298     <dd>When processing the specified latitude and longitude points only select
299     the nearest node instead of finding the nearest point within a segment
300     (quicker but less accurate unless the points are already near nodes).
301 amb 586 <dt>--loggable
302     <dd>Print progress messages that are suitable for logging to a file; normally
303 amb 737 an incrementing counter is printed which is more suitable for real-time
304 amb 586 display than logging.
305 amb 577 <dt>--quiet
306     <dd>Don't generate any screen output while running (useful for running in a script).
307     <dt>--language=&lt;lang&gt;
308     <dd>Select the language specified from the file of translations. If this
309     option is not given and the file exists then the first language in the file
310     will be used. If this option is not given and no file exists the
311     compiled-in default language (English) will be used.
312     <dt>--output-html
313     <dt>--output-gpx-track
314     <dt>--output-gpx-route
315     <dt>--output-text
316     <dt>--output-text-all
317     <dd>Generate the selected output file formats (HTML, GPX track file, GPX route
318     file, plain text route and/or plain text with all nodes). If no output is
319     specified then all are generated, specifying any automatically disables those
320     not specified.
321     <dt>--output-none
322     <dd>Do not generate any output or read in any translations files.
323     <dt>--profile=&lt;name&gt;
324     <dd>Specifies the name of the profile to use.
325     <dt>--transport=&lt;transport&gt;
326     <dd>Select the type of transport to use, &lt;transport&gt; can be set to:
327     <ul>
328     <li>foot = Foot
329     <li>horse = Horse
330     <li>wheelchair = Wheelchair
331     <li>bicycle = Bicycle
332 amb 1243 <li>moped = Moped (Small motorcycle, limited speed)
333     <li>motorcycle = Motorcycle
334 amb 577 <li>motorcar = Motorcar
335     <li>goods = Goods (Small lorry, van)
336     <li>hgv = HGV (Heavy Goods Vehicle - large lorry)
337     <li>psv = PSV (Public Service Vehicle - bus, coach)
338     </ul>
339     Defaults to 'motorcar', this option also selects the default profile
340     information if the '--profile' option is not given and a profile matching
341     the transport name is found.
342     <dt>--shortest
343     <dd>Find the shortest route between the waypoints.
344     <dt>--quickest
345     <dd>Find the quickest route between the waypoints.
346     <dt>--lon1=&lt;longitude&gt;, --lat1=&lt;latitude&gt;
347     <dt>--lon2=&lt;longitude&gt;, --lat2=&lt;latitude&gt;
348     <dt>... --lon99=&lt;longitude&gt;, --lat99=&lt;latitude&gt;
349     <dd>The location of the waypoints that make up the start, middle and end
350     points of the route. Up to 99 waypoints can be specified and the route will
351     pass through each of the specified ones in sequence. The algorithm will use
352     the closest node or point within a segment that allows the specified traffic
353     type.
354 amb 675 <dt>--heading=&lt;bearing&gt;
355     <dd>Specifies the initial direction of travel at the start of the route (from
356 amb 737 the lowest numbered waypoint) as a compass bearing from 0 to 360 degrees.
357 amb 577 <dt>--highway-&lt;highway&gt;=&lt;preference&gt;
358     <dd>Selects the percentage preference for using each particular type of
359     highway. The value of &lt;highway&gt; can be selected from:
360     <ul>
361     <li>motorway = Motorway
362     <li>trunk = Trunk
363     <li>primary = Primary
364     <li>secondary = Secondary
365     <li>tertiary = Tertiary
366     <li>unclassified = Unclassified
367     <li>residential = Residential
368     <li>service = Service
369     <li>track = Track
370     <li>cycleway = Cycleway
371     <li>path = Path
372     <li>steps = Steps
373 amb 586 <li>ferry = Ferry
374 amb 577 </ul>
375     Default value depends on the profile selected by the --transport option.
376     <dt>--speed-&lt;highway&gt;=&lt;speed&gt;
377     <dd>Selects the speed limit in km/hour for each type of highway. Default
378     value depends on the profile selected by the --transport option.
379     <dt>--property-&lt;property&gt;=&lt;preference&gt;
380     <dd>Selects the percentage preference for using each particular highway
381     property
382     The value of &lt;property&gt; can be selected from:
383     <ul>
384 amb 585 <li>paved = Paved (suitable for normal wheels)
385     <li>multilane = Multiple lanes
386     <li>bridge = Bridge
387     <li>tunnel = Tunnel
388     <li>footroute = A route marked for foot travel
389     <li>bicycleroute = A route marked for bicycle travel
390 amb 577 </ul>
391     Default value depends on the profile selected by the --transport option.
392     <dt>--oneway=[0|1]
393     <dd>Selects if the direction of oneway streets are to be obeyed (useful to not
394     obey them when walking). Default value depends on the profile selected by
395     the --transport option.
396 amb 622 <dt>--turns=[0|1]
397     <dd>Selects if turn restrictions are to be obeyed (useful to not obey them
398     when walking). Default value depends on the profile selected by the
399     --transport option.
400 amb 577 <dt>--weight=&lt;weight&gt;
401     <dd>Specifies the weight of the mode of transport in tonnes; ensures that the
402     weight limit on the highway is not exceeded. Default value depends on the
403     profile selected by the --transport option.
404     <dt>--height=&lt;height&gt;
405     <dd>Specifies the height of the mode of transport in metres; ensures that the
406     height limit on the highway is not exceeded. Default value depends on the
407     profile selected by the --transport option.
408     <dt>--width=&lt;width&gt;
409     <dd>Specifies the width of the mode of transport in metres; ensures that the
410     width limit on the highway is not exceeded. Default value depends on the
411     profile selected by the --transport option.
412     <dt>--length=&lt;length&gt;
413     <dd>Specifies the length of the mode of transport in metres; ensures that the
414     length limit on the highway is not exceeded. Default value depends on the
415     profile selected by the --transport option.
416     </dl>
417    
418     <p>
419 amb 585 <i>Note: In version 1.5 of Routino a slim option has been added and at
420     compilation time a separate program called <em>router-slim</em> is created that
421     operates in slim mode. In slim mode the database files are read as needed
422     rather than being mapped into memory.</i>
423    
424     <p>
425 amb 577 The meaning of the &lt;preference&gt; parameter in the command line options is
426     slightly different for the highway preferences and the property preferences.
427     For the highway preference consider the choice between two possible highways
428     between the start and finish when looking for the shortest route. If highway A
429     has a preference of 100% and highway B has a preference of 90% then highway A
430     will be chosen even if it is up to 11% longer (100/90 = 111%). For the highway
431     properties each highway either has a particular property or not. If the
432 amb 585 preference for the property is 60% then a highway with the property has a
433     preference of 77% (sqrt(60%)) and one without has a preference of 63%
434     (sqrt(100-60%)). A highway with the property will be chosen even if it is up to
435     22% longer than one without the property (77/63 = 122%). The overall preference
436     for each highway segment is the product of the preference for the highway type
437     and all of the preferences for the highway properties.
438 amb 577
439     <p>
440 amb 1243 Example usage (motorcycle journey, scenic route, not very fast):
441 amb 577
442     <pre class="boxed">
443 amb 1243 router --dir=data --prefix=gb --transport=motorcycle --highway-motorway=0 \
444 amb 1120 --highway-trunk=0 --speed-primary=80 --speed-secondary=80 --quickest
445 amb 577 </pre>
446    
447     This will use the files 'data/gb-nodes.mem', 'data/gb-segments.mem' and
448 amb 1243 'data/gb-ways.mem' to find the quickest route by motorcycle not using motorways
449 amb 577 or trunk roads and not exceeding 80 km/hr.
450    
451    
452     <h3><a name="H_1_1_3"></a>filedumper</h3>
453    
454     This program is used to extract statistics from the database, extract particular
455     information for visualisation purposes or for dumping the database contents.
456    
457     <pre class="boxed">
458     Usage: filedumper [--help]
459     [--dir=&lt;dirname&gt;] [--prefix=&lt;name&gt;]
460     [--statistics]
461     [--visualiser --latmin=&lt;latmin&gt; --latmax=&lt;latmax&gt;
462     --lonmin=&lt;lonmin&gt; --lonmax=&lt;lonmax&gt;
463     --data=&lt;data-type&gt;]
464     [--dump [--node=&lt;node&gt; ...]
465     [--segment=&lt;segment&gt; ...]
466 amb 592 [--way=&lt;way&gt; ...]
467 amb 1323 [--turn-relation=&lt;relation&gt; ...]
468 amb 1330 [--errorlog=&lt;number&gt; ...]]
469 amb 577 [--dump-osm [--no-super]
470     [--latmin=&lt;latmin&gt; --latmax=&lt;latmax&gt;
471     --lonmin=&lt;lonmin&gt; --lonmax=&lt;lonmax&gt;]]
472 amb 1330 [--dump--visualiser [--data=node&lt;node&gt;]
473     [--data=segment&lt;segment&gt;]
474     [--data=turn-relation&lt;rel&gt;]
475     [--data=errorlog&lt;number&gt;]]
476 amb 577 </pre>
477    
478     <dl>
479     <dt>--help
480     <dd>Prints out the help information.
481     <dt>--dir=&lt;dirname&gt;
482     <dd>Sets the directory name in which to read the local database.
483     Defaults to the current directory.
484     <dt>--prefix=&lt;name&gt;
485     <dd>Sets the filename prefix for the files in the local database.
486     <dt>--statistics
487     <dd>Prints out statistics about the database files.
488     <dt>--visualiser
489     <dd>Selects a data visualiser mode which will output a set of data according
490     to the other parameters below.
491     <dl>
492     <dt>--latmin=&lt;latmin&gt; --latmax=&lt;latmax&gt;
493     <dd>The range of latitudes to print the data for.
494     <dt>--lonmin=&lt;lonmin&gt; --lonmax=&lt;lonmax&gt;
495     <dd>The range of longitudes to print the data for.
496     <dt>--data=&lt;data-type&gt;
497     <dd>The type of data to output, &lt;data-type&gt; can be selected from:
498     <ul>
499 amb 1002 <li>junctions = segment count at each junction.
500     <li>super = super-node and super-segments.
501     <li>oneway = oneway segments.
502 amb 1003 <li>highway-* = segments of the specified highway type
503     (e.g. highway-primary to display segments ofprimary roads).
504 amb 1002 <li>transport-* = segments allowing the specified transport type
505     (e.g. transport-foot to display segments accessible on foot).
506     <li>turns = turn restrictions.
507     <li>speed = speed limits.
508     <li>weight = weight limits.
509     <li>height = height limits.
510     <li>width = width limits.
511     <li>length = length limits.
512 amb 1248 <li>property-* = segments having the specified property
513     (e.g. property-paved to display segments of paved highway).
514 amb 1323 <li>errorlogs = errors logged during parsing.
515 amb 577 </ul>
516     </dl>
517     <dt>--dump
518     <dd>Selects a data dumping mode which allows looking at individual items in
519     the databases (specifying 'all' instead of a number dumps all of them).
520 amb 601 More than one of the following parameters can be specified on the command
521     line.
522 amb 577 <dl>
523     <dt>--node=&lt;node&gt;
524     <dd>Prints the information about the selected node number (internal
525     number, not the node id number in the original source file).
526     <dt>--segment=&lt;segment&gt;
527     <dd>Prints the information about the selected segment number.
528     <dt>--way=&lt;way&gt;
529     <dd>Prints the information about the selected way number (internal
530     number, not the way id number in the original source file).
531 amb 601 <dt>--turn-relation=&lt;relation&gt;
532     <dd>Prints the information about the selected turn relation number
533     (internal number, not the relation id number in the original source
534     file).
535 amb 1323 <dt>--errorlog=&lt;number&gt;
536     <dd>Prints the information about the selected error log that was stored
537     when the data was parsed.
538 amb 577 </dl>
539     <dt>--osm-dump
540     <dd>Dumps the contents of the database as an OSM format XML file, the whole
541     database will be dumped unless the latitude and longitude ranges are
542     specified.
543     <dl>
544     <dt>--no-super
545     <dd>The super segments will not be output.
546     <dt>--latmin=&lt;latmin&gt; --latmax=&lt;latmax&gt;
547     <dd>The range of latitudes to dump the data for.
548     <dt>--lonmin=&lt;lonmin&gt; --lonmax=&lt;lonmax&gt;
549     <dd>The range of longitudes to dump the data for.
550     </dl>
551 amb 1330 <dt>--dump-visualiser
552     <dd>Dumps the contents of the database as HTML formatted items for display in
553     the visualiser web page.
554     <dl>
555     <dt>--data=node&lt;node&gt;
556     <dd>Prints the information about the selected node number (internal
557     node number, not from the original source file).
558     <dt>--data=segment&lt;segment&gt;
559     <dd>Prints the information about the selected segment number as if it was
560     a way (internal segment number, unrelated to original source file).
561     <dt>--data=turn-relation&lt;relation&gt;
562     <dd>Prints the information about the selected turn relation number
563     (internal turn relation number, not from the original source file).
564     <dt>--data=errorlog&lt;number&gt;
565     <dd>Prints the information about the selected error log that was stored
566     when the data was parsed.
567     </dl>
568 amb 577 </dl>
569    
570 amb 585 <p>
571     <i>Note: In version 1.5 of Routino a slim option has been added and at
572     compilation time a separate program called <em>filedumper-slim</em> is created
573     that operates in slim mode. In slim mode the database files are read as needed
574     rather than being mapped into memory.</i>
575 amb 577
576 amb 585
577 amb 1149 <h3><a name="H_1_1_4"></a>filedumperx</h3>
578 amb 577
579 amb 1149 This program is a modified version of filedumper that will dump out the contents
580     of the intermediate data that is saved by planetsplitter after processing using
581 amb 1167 the --keep or --changes option. This is intended for test purposes only and
582 amb 1149 gives no useful information about the routing database.
583    
584     <pre class="boxed">
585 amb 1340 Usage: filedumperx [--help]
586     [--dir=&lt;dirname&gt;] [--prefix=&lt;name&gt;]
587     [--dump [--nodes]
588     [--ways]
589     [--route-relations]
590     [--turn-relations]]
591 amb 1149 </pre>
592    
593     <dl>
594     <dt>--help
595     <dd>Prints out the help information.
596     <dt>--dir=&lt;dirname&gt;
597     <dd>Sets the directory name in which to read the local database.
598     Defaults to the current directory.
599     <dt>--prefix=&lt;name&gt;
600     <dd>Sets the filename prefix for the files in the local database.
601     <dt>--dump
602     <dd>Dumps the complete set of data in the intermediate files that are written
603 amb 1167 by planetsplitter using the --keep or --changes options.
604 amb 1149 <dl>
605     <dt>--nodes
606     <dd>Dumps the node data.
607     <dt>--ways
608     <dd>Dumps the way data.
609     <dt>--route-relations
610     <dd>Dumps the route relation data.
611     <dt>--turn-relations
612     <dd>Dumps the turn relation data.
613     </dl>
614     </dl>
615    
616 amb 577 </div>
617    
618     <!-- Content End -->
619    
620     <!-- Footer Start -->
621    
622     <div class="footer" align="center">
623     <hr>
624    
625     <address>
626 amb 1267 &copy; Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a>
627 amb 577 </address>
628    
629     </div>
630    
631     <!-- Footer End -->
632    
633     </BODY>
634    
635     </HTML>