3pp-mirror/map-machine
1
0
Fork 0
mirror of https://github.com/enzet/map-machine.git synced 2025-04-28 17:57:11 +02:00
Code Issues Projects Releases Packages Wiki Activity

Use space instead of = in examples.

Browse source 
`=` is needed no more.
This commit is contained in:
Sergey Vartanov 2022-10-30 11:49:07 +04:00
parent eba1ed1606
commit b67fe8e574
2 changed files with 34 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -27,13 +27,13 @@ Usage example
------------- -------------
```shell ```shell
map-machine render -b=2.284,48.860,2.290,48.865 map-machine render -b 2.284,48.860,2.290,48.865
``` ```
will automatically download OSM data and render an SVG map of the specified area to `out/map.svg`. See [Map generation](#map-generation). will automatically download OSM data and render an SVG map of the specified area to `out/map.svg`. See [Map generation](#map-generation).
```shell ```shell
map-machine tile -b=2.361,48.871,2.368,48.875 map-machine tile -b 2.361,48.871,2.368,48.875
``` ```
will automatically download OSM data and render PNG tiles that cover the specified area to the `out/tiles` directory. See [Tile generation](#tile-generation). will automatically download OSM data and render PNG tiles that cover the specified area to the `out/tiles` directory. See [Tile generation](#tile-generation).
@ -65,7 +65,7 @@ With `--buildings isometric` or `--buildings isometric-no-parts` (not set by def
#### Example #### #### Example ####
```shell ```shell
map-machine render -c=-26.19049,28.05605 -s 600,400 --buildings isometric map-machine render -c -26.19049,28.05605 -s 600,400 --buildings isometric
``` ```
![3D buildings](doc/buildings.svg) ![3D buildings](doc/buildings.svg)
@ -194,9 +194,9 @@ The `render` command is used to generate an SVG map from OpenStreetMap data. You
```shell ```shell
map-machine render \ map-machine render \
-b=<min longitude>,<min latitude>,<max longitude>,<max latitude> \ -b <min longitude>,<min latitude>,<max longitude>,<max latitude> \
-o=<output file name> \ -o <output file name> \
-z=<OSM zoom level> \ -z <OSM zoom level> \
<other arguments> <other arguments>
``` ```
@ -204,8 +204,8 @@ map-machine render \
```shell ```shell
map-machine render \ map-machine render \
--boundary-box=2.284,48.860,2.290,48.865 \ --boundary-box 2.284,48.860,2.290,48.865 \
--output=out/esplanade_du_trocadéro.svg --output out/esplanade_du_trocadéro.svg
``` ```
will download OSM data to `cache/2.284,48.860,2.290,48.865.osm` and render an SVG map of the specified area to `out/esplanade_du_trocadéro.svg`. will download OSM data to `cache/2.284,48.860,2.290,48.865.osm` and render an SVG map of the specified area to `out/esplanade_du_trocadéro.svg`.
@ -216,10 +216,10 @@ will download OSM data to `cache/2.284,48.860,2.290,48.865.osm` and render an SV
|---|---| |---|---|
| <span style="white-space: nowrap;">`-i`</span>, <span style="white-space: nowrap;">`--input`</span> `<path>` | input XML file name or names (if not specified, file will be downloaded using the OpenStreetMap API) | | <span style="white-space: nowrap;">`-i`</span>, <span style="white-space: nowrap;">`--input`</span> `<path>` | input XML file name or names (if not specified, file will be downloaded using the OpenStreetMap API) |
| <span style="white-space: nowrap;">`-o`</span>, <span style="white-space: nowrap;">`--output`</span> `<path>` | output SVG file name, default value: `out/map.svg` | | <span style="white-space: nowrap;">`-o`</span>, <span style="white-space: nowrap;">`--output`</span> `<path>` | output SVG file name, default value: `out/map.svg` |
| <span style="white-space: nowrap;">`-b`</span>, <span style="white-space: nowrap;">`--boundary-box`</span> `<lon1>,<lat1>,<lon2>,<lat2>` | geo boundary box; if the first value is negative, use the `=` sign or enclose the value with quotes and prefix a space before `-`, e.g. `-b=-84.752,39.504,-84.749,39.508` or `-b " -84.752,39.504,-84.749,39.508"` | | <span style="white-space: nowrap;">`-b`</span>, <span style="white-space: nowrap;">`--boundary-box`</span> `<lon1>,<lat1>,<lon2>,<lat2>` | geo boundary box |
| <span style="white-space: nowrap;">`--cache`</span> `<path>` | path for temporary OSM files, default value: `cache` | | <span style="white-space: nowrap;">`--cache`</span> `<path>` | path for temporary OSM files, default value: `cache` |
| <span style="white-space: nowrap;">`-z`</span>, <span style="white-space: nowrap;">`--zoom`</span> `<float>` | OSM zoom level, default value: 18.0 | | <span style="white-space: nowrap;">`-z`</span>, <span style="white-space: nowrap;">`--zoom`</span> `<float>` | OSM zoom level, default value: 18.0 |
| <span style="white-space: nowrap;">`-c`</span>, <span style="white-space: nowrap;">`--coordinates`</span> `<latitude>,<longitude>` | coordinates of any location inside the tile; if the first value is negative, use the `=` sign or enclose the value with quotes and prefix a space before `-`, e.g. `-c=-84.752,39.504` or `-c " -84.752,39.504"` | | <span style="white-space: nowrap;">`-c`</span>, <span style="white-space: nowrap;">`--coordinates`</span> `<latitude>,<longitude>` | coordinates of any location inside the tile |
| <span style="white-space: nowrap;">`-s`</span>, <span style="white-space: nowrap;">`--size`</span> `<width>,<height>` | resulted image size | | <span style="white-space: nowrap;">`-s`</span>, <span style="white-space: nowrap;">`--size`</span> `<width>,<height>` | resulted image size |
plus [map configuration options](#map-options) plus [map configuration options](#map-options)
@ -231,10 +231,10 @@ Command `tile` is used to generate PNG tiles for [slippy maps](https://wiki.open
| Option | Description | | Option | Description |
|---|---| |---|---|
| <span style="white-space: nowrap;">`-c`</span>, <span style="white-space: nowrap;">`--coordinates`</span> `<latitude>,<longitude>` | coordinates of any location inside the tile; if the first value is negative, use the `=` sign or enclose the value with quotes and prefix a space before `-`, e.g. `-c=-84.752,39.504` or `-c " -84.752,39.504"` | | <span style="white-space: nowrap;">`-c`</span>, <span style="white-space: nowrap;">`--coordinates`</span> `<latitude>,<longitude>` | coordinates of any location inside the tile |
| <span style="white-space: nowrap;">`-t`</span>, <span style="white-space: nowrap;">`--tile`</span> `<zoom level>/<x>/<y>` | tile specification | | <span style="white-space: nowrap;">`-t`</span>, <span style="white-space: nowrap;">`--tile`</span> `<zoom level>/<x>/<y>` | tile specification |
| <span style="white-space: nowrap;">`--cache`</span> `<path>` | path for temporary OSM files, default value: `cache` | | <span style="white-space: nowrap;">`--cache`</span> `<path>` | path for temporary OSM files, default value: `cache` |
| <span style="white-space: nowrap;">`-b`</span>, <span style="white-space: nowrap;">`--boundary-box`</span> `<lon1>,<lat1>,<lon2>,<lat2>` | construct the minimum amount of tiles that cover the requested boundary box; if the first value is negative, use the `=` sign or enclose the value with quotes and prefix a space before `-`, e.g. `-b=-84.752,39.504,-84.749,39.508` or `-b " -84.752,39.504,-84.749,39.508"` | | <span style="white-space: nowrap;">`-b`</span>, <span style="white-space: nowrap;">`--boundary-box`</span> `<lon1>,<lat1>,<lon2>,<lat2>` | construct the minimum amount of tiles that cover the requested boundary box |
| <span style="white-space: nowrap;">`-z`</span>, <span style="white-space: nowrap;">`--zoom`</span> `<range>` | OSM zoom levels; can be list of numbers or ranges, e.g. `16-18`, `16,17,18`, or `16,18-20`, default value: `18` | | <span style="white-space: nowrap;">`-z`</span>, <span style="white-space: nowrap;">`--zoom`</span> `<range>` | OSM zoom levels; can be list of numbers or ranges, e.g. `16-18`, `16,17,18`, or `16,18-20`, default value: `18` |
| <span style="white-space: nowrap;">`-i`</span>, <span style="white-space: nowrap;">`--input`</span> `<path>` | input OSM XML file name (if not specified, the file will be downloaded using the OpenStreetMap API) | | <span style="white-space: nowrap;">`-i`</span>, <span style="white-space: nowrap;">`--input`</span> `<path>` | input OSM XML file name (if not specified, the file will be downloaded using the OpenStreetMap API) |
@ -252,8 +252,8 @@ or specify any geographical coordinates inside a tile:
```shell ```shell
map-machine tile \ map-machine tile \
--coordinates=<latitude>,<longitude> \ --coordinates <latitude>,<longitude> \
--zoom=<OSM zoom levels> --zoom <OSM zoom levels>
``` ```
The tile will be stored as an SVG file `out/tiles/tile_<zoom level>_<x>_<y>.svg` and a PNG file `out/tiles/tile_<zoom level>_<x>_<y>.svg`, where `x` and `y` are tile coordinates. The `--zoom` option will be ignored if it is used with the `--tile` option. The tile will be stored as an SVG file `out/tiles/tile_<zoom level>_<x>_<y>.svg` and a PNG file `out/tiles/tile_<zoom level>_<x>_<y>.svg`, where `x` and `y` are tile coordinates. The `--zoom` option will be ignored if it is used with the `--tile` option.
@ -261,7 +261,7 @@ The tile will be stored as an SVG file `out/tiles/tile_<zoom level>_<x>_<y>.svg`
Example: Example:
```shell ```shell
map-machine tile -c=55.7510637,37.6270761 -z=18 map-machine tile -c 55.7510637,37.6270761 -z 18
``` ```
will generate an SVG file `out/tiles/tile_18_158471_81953.svg` and a PNG file `out/tiles/tile_18_158471_81953.png`. will generate an SVG file `out/tiles/tile_18_158471_81953.svg` and a PNG file `out/tiles/tile_18_158471_81953.png`.
@ -272,8 +272,8 @@ Specify the boundary box to get the minimal set of tiles that covers the area:
```shell ```shell
map-machine tile \ map-machine tile \
--boundary-box=<min longitude>,<min latitude>,<max longitude>,<max latitude> \ --boundary-box <min longitude>,<min latitude>,<max longitude>,<max latitude> \
--zoom=<OSM zoom levels> --zoom <OSM zoom levels>
``` ```
The boundary box will be extended to the boundaries of the minimal tileset that covers the area, then it will be extended a bit more to avoid some artifacts on the edges rounded to 3 digits after the decimal point. The map with the new boundary box coordinates will be written to the cache directory as SVG and PNG files. All tiles will be stored as SVG files `out/tiles/tile_<zoom level>_<x>_<y>.svg` and PNG files `out/tiles/tile_<zoom level>_<x>_<y>.svg`, where `x` and `y` are tile coordinates. The boundary box will be extended to the boundaries of the minimal tileset that covers the area, then it will be extended a bit more to avoid some artifacts on the edges rounded to 3 digits after the decimal point. The map with the new boundary box coordinates will be written to the cache directory as SVG and PNG files. All tiles will be stored as SVG files `out/tiles/tile_<zoom level>_<x>_<y>.svg` and PNG files `out/tiles/tile_<zoom level>_<x>_<y>.svg`, where `x` and `y` are tile coordinates.
@ -281,7 +281,7 @@ The boundary box will be extended to the boundaries of the minimal tileset that
Example: Example:
```shell ```shell
map-machine tile -b=2.361,48.871,2.368,48.875 map-machine tile -b 2.361,48.871,2.368,48.875
``` ```
will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the way to 18/132796/90169 and two cached files `cache/2.360,48.869,2.370,48.877_18.svg` and `cache/2.360,48.869,2.370,48.877_18.png`. will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the way to 18/132796/90169 and two cached files `cache/2.360,48.869,2.370,48.877_18.svg` and `cache/2.360,48.869,2.370,48.877_18.png`.
@ -307,7 +307,7 @@ Stop server interrupting the process with <kbd>Ctrl</kbd> + <kbd>C</kbd>.
Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19: Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19:
```shell ```shell
map-machine tile -b=2.364,48.854,2.367,48.857 -z=16-19 map-machine tile -b 2.364,48.854,2.367,48.857 -z 16-19
``` ```
Run tile server on 127.0.0.1:8080: Run tile server on 127.0.0.1:8080:

30
doc/moi/readme.moi
View file

@ -21,11 +21,11 @@ See
\2 {Usage example} {usage-example} \2 {Usage example} {usage-example}
\code {shell} {map-machine render -b=2.284,48.860,2.290,48.865} \code {shell} {map-machine render -b 2.284,48.860,2.290,48.865}
will automatically download OSM data and render an SVG map of the specified area to \m {out/map.svg}. See \ref {#map-generation} {Map generation}. will automatically download OSM data and render an SVG map of the specified area to \m {out/map.svg}. See \ref {#map-generation} {Map generation}.
\code {shell} {map-machine tile -b=2.361,48.871,2.368,48.875} \code {shell} {map-machine tile -b 2.361,48.871,2.368,48.875}
will automatically download OSM data and render PNG tiles that cover the specified area to the \m {out/tiles} directory. See \ref {#tile-generation} {Tile generation}. will automatically download OSM data and render PNG tiles that cover the specified area to the \m {out/tiles} directory. See \ref {#tile-generation} {Tile generation}.
@ -53,7 +53,7 @@ With \m {--buildings isometric} or \m {--buildings isometric-no-parts} (not set
\4 {Example} \4 {Example}
\code {shell} {map-machine render -c=-26.19049,28.05605 -s 600,400 --buildings isometric} \code {shell} {map-machine render -c -26.19049,28.05605 -s 600,400 --buildings isometric}
\image {doc/buildings.svg} {3D buildings} \image {doc/buildings.svg} {3D buildings}
@ -233,16 +233,16 @@ For more detailed instructions, see \ref {doc/INSTALL.md} {instructions}.
The \m {render} command is used to generate an SVG map from OpenStreetMap data. You can run it using\: The \m {render} command is used to generate an SVG map from OpenStreetMap data. You can run it using\:
\code {shell} {map-machine render \\ \code {shell} {map-machine render \\
-b=\formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\ -b \formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\
-o=\formal {output file name} \\ -o \formal {output file name} \\
-z=\formal {OSM zoom level} \\ -z \formal {OSM zoom level} \\
\formal {other arguments}} \formal {other arguments}}
\3 {Example} {example} \3 {Example} {example}
\code {shell} {map-machine render \\ \code {shell} {map-machine render \\
--boundary-box=2.284,48.860,2.290,48.865 \\ --boundary-box 2.284,48.860,2.290,48.865 \\
--output=out/esplanade_du_trocadéro.svg} --output out/esplanade_du_trocadéro.svg}
will download OSM data to \m {cache/2.284,48.860,2.290,48.865.osm} and render an SVG map of the specified area to \m {out/esplanade_du_trocadéro.svg}. will download OSM data to \m {cache/2.284,48.860,2.290,48.865.osm} and render an SVG map of the specified area to \m {out/esplanade_du_trocadéro.svg}.
@ -269,14 +269,14 @@ Specify the tile coordinates\:
or specify any geographical coordinates inside a tile\: or specify any geographical coordinates inside a tile\:
\code {shell} {map-machine tile \\ \code {shell} {map-machine tile \\
--coordinates=\formal {latitude},\formal {longitude} \\ --coordinates \formal {latitude},\formal {longitude} \\
--zoom=\formal {OSM zoom levels}} --zoom \formal {OSM zoom levels}}
The tile will be stored as an SVG file \m {out/tiles/tile_<zoom level>_<x>_<y>.svg} and a PNG file \m {out/tiles/tile_<zoom level>_<x>_<y>.svg}, where \m {x} and \m {y} are tile coordinates. The \m {--zoom} option will be ignored if it is used with the \m {--tile} option. The tile will be stored as an SVG file \m {out/tiles/tile_<zoom level>_<x>_<y>.svg} and a PNG file \m {out/tiles/tile_<zoom level>_<x>_<y>.svg}, where \m {x} and \m {y} are tile coordinates. The \m {--zoom} option will be ignored if it is used with the \m {--tile} option.
Example\: Example\:
\code {shell} {map-machine tile -c=55.7510637,37.6270761 -z=18} \code {shell} {map-machine tile -c 55.7510637,37.6270761 -z 18}
will generate an SVG file \m {out/tiles/tile_18_158471_81953.svg} and a PNG file \m {out/tiles/tile_18_158471_81953.png}. will generate an SVG file \m {out/tiles/tile_18_158471_81953.svg} and a PNG file \m {out/tiles/tile_18_158471_81953.png}.
@ -285,14 +285,14 @@ will generate an SVG file \m {out/tiles/tile_18_158471_81953.svg} and a PNG file
Specify the boundary box to get the minimal set of tiles that covers the area\: Specify the boundary box to get the minimal set of tiles that covers the area\:
\code {shell} {map-machine tile \\ \code {shell} {map-machine tile \\
--boundary-box=\formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\ --boundary-box \formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\
--zoom=\formal {OSM zoom levels}} --zoom \formal {OSM zoom levels}}
The boundary box will be extended to the boundaries of the minimal tileset that covers the area, then it will be extended a bit more to avoid some artifacts on the edges rounded to 3 digits after the decimal point. The map with the new boundary box coordinates will be written to the cache directory as SVG and PNG files. All tiles will be stored as SVG files \m {out/tiles/tile_<zoom level>_<x>_<y>.svg} and PNG files \m {out/tiles/tile_<zoom level>_<x>_<y>.svg}, where \m {x} and \m {y} are tile coordinates. The boundary box will be extended to the boundaries of the minimal tileset that covers the area, then it will be extended a bit more to avoid some artifacts on the edges rounded to 3 digits after the decimal point. The map with the new boundary box coordinates will be written to the cache directory as SVG and PNG files. All tiles will be stored as SVG files \m {out/tiles/tile_<zoom level>_<x>_<y>.svg} and PNG files \m {out/tiles/tile_<zoom level>_<x>_<y>.svg}, where \m {x} and \m {y} are tile coordinates.
Example\: Example\:
\code {shell} {map-machine tile -b=2.361,48.871,2.368,48.875} \code {shell} {map-machine tile -b 2.361,48.871,2.368,48.875}
will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the way to 18/132796/90169 and two cached files \m {cache/2.360,48.869,2.370,48.877_18.svg} and \m {cache/2.360,48.869,2.370,48.877_18.png}. will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the way to 18/132796/90169 and two cached files \m {cache/2.360,48.869,2.370,48.877_18.svg} and \m {cache/2.360,48.869,2.370,48.877_18.png}.
@ -310,7 +310,7 @@ Stop server interrupting the process with \kbd {Ctrl} + \kbd {C}.
Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19\: Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19\:
\code {shell} {map-machine tile -b=2.364,48.854,2.367,48.857 -z=16-19} \code {shell} {map-machine tile -b 2.364,48.854,2.367,48.857 -z 16-19}
Run tile server on 127.0.0.1\:8080\: Run tile server on 127.0.0.1\:8080\: