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