diff --git a/AUTHORS b/AUTHORS index 63a97723..de5cddf0 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,7 @@ Ævar Arnfjörð Bjarmason -Anton Belichkov +Amanda Andreas Hubel +Anton Belichkov Bas Couwenberg Ben Hosmer Ben Kochie @@ -22,6 +23,7 @@ Lennard voor den Dag Manfred Stock Matt Amos Michael Fazio +Michael Schmiedgen Moritz Seemann Paul Norman Peter Körner @@ -30,8 +32,11 @@ Ramunas Robert Buchholz rusvdw Sean Reifschneider +SomeoneElseOSM +Stephan Austermühle Stephan Knauss Stephan Plepelits Tom Hughes +vholten Xin Yu Zverik diff --git a/CMakeLists.txt b/CMakeLists.txt index 83972b8c..08a69ff2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -279,6 +279,11 @@ if(ENABLE_MAN) docs/man/renderd.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 ) + install( + FILES + docs/man/renderd.conf.5 + DESTINATION ${CMAKE_INSTALL_MANDIR}/man5 + ) endif() #----------------------------------------------------------------------------- diff --git a/Makefile.am b/Makefile.am index db72433b..f822e008 100644 --- a/Makefile.am +++ b/Makefile.am @@ -28,6 +28,7 @@ noinst_PROGRAMS = gen_tile_test man_MANS = \ docs/man/renderd.1 \ + docs/man/renderd.conf.5 \ docs/man/render_expired.1 \ docs/man/render_list.1 \ docs/man/render_old.1 \ diff --git a/docs/man/convert_meta.1 b/docs/man/convert_meta.1 index c9d21d45..b25f5517 100644 --- a/docs/man/convert_meta.1 +++ b/docs/man/convert_meta.1 @@ -1,11 +1,14 @@ -.TH CONVERT_META 1 "Jan 25, 2012" +.TH CONVERT_META "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME convert_meta \- A conversion program from .png map tiles to a more efficient conglomerate format (.meta). + .SH SYNOPSIS .B convert_meta .RI [ options ] -.br +.BR + .SH DESCRIPTION This manual page documents briefly the .B convert_meta @@ -16,6 +19,7 @@ converts individual .png map tiles into the more efficient .meta file format. Th format stores a grid of 8x8 tiles in a single meta tile, reducing the number of files by a factor of 64. .PP + .SH OPTIONS This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). @@ -37,6 +41,7 @@ Specify the smallest zoom level to process. The default is 0. \fB\-Z\fR|\-\-max-zoom Specify the largest zoom level up to which to process tiles. The default is 18. .PP + .SH AUTHOR convert_meta was written by Jon Burgess and other OpenStreetMap project members. diff --git a/docs/man/openstreetmap-tiles-update-expire.1 b/docs/man/openstreetmap-tiles-update-expire.1 index b1348fb5..e2a33fd7 100644 --- a/docs/man/openstreetmap-tiles-update-expire.1 +++ b/docs/man/openstreetmap-tiles-update-expire.1 @@ -1,11 +1,14 @@ -.TH TILES-UPDATE-EXPIRE 1 "Apr 20, 2013" +.TH TILES-UPDATE-EXPIRE "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME openstreetmap-tiles-update-expire \- updates a map database from the OSM diff stream. + .SH SYNOPSIS .B openstreetmap-tiles-update-expire .RI [ YYYY-MM-DD ] -.br +.BR + .SH DESCRIPTION This manual page documents briefly the .B openstreetmap-tiles-update-expire @@ -15,18 +18,19 @@ command. is a helper script to keep a mod_tile based openstreetmap tile server up to date. It downloads a diff stream from OpenStreetMap using osmosis, then applies it to your database using osm2pgsql and finally marks changed tiles on disk as "dirty". -.br +.BR Each time you call this script, it does one update cycle. If your db is further behind than the maximum duration for which osmosis is configured to fetch diffs, the db will not be fully up-to-date at the end of this script and it will be necessary to call it multiple times for a fully up-to-date database. -.br +.BR This script can be used in conjunction with cron to automatically keep your database in sync with the OSM diff stream. .PP The first time this script needs to be called with a date to initialise the process. Thereafter, the script gets called without arguments. .PP + .SH OPTIONS .TP \fBYYYY-MM-DD @@ -36,10 +40,11 @@ ensures that there is no missing data due to a gap between the generation of the the start of the diff processing. .PP + .SH SEE ALSO -.BR renderd (8), -.BR mod_tile (1). -.br +.BR renderd(1) +.BR + .SH AUTHOR openstreetmap-tiles-update-expire was written by OpenStreetMap project members. .PP diff --git a/docs/man/render_expired.1 b/docs/man/render_expired.1 index 3b243cbd..9d655d8e 100644 --- a/docs/man/render_expired.1 +++ b/docs/man/render_expired.1 @@ -1,11 +1,14 @@ -.TH RENDER_EXPIRED 1 "Nov 25, 2023" +.TH RENDER_EXPIRED "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME render_expired \- expires a list of map tiles so that they get re-rendered. + .SH SYNOPSIS .B render_expired .RI [ options ] < "expire.list" -.br +.BR + .SH DESCRIPTION This manual page documents briefly the .B render_expired @@ -14,27 +17,28 @@ command. .B render_expired is a helper utility that takes a list of map tiles from stdin and expires them such that they will get re-rendered. Render_expired has three potential strategies of how to expire map tiles: -.br +.BR 1) Render tiles directly: Render_expired can connect to the renderd socket and submit rendering requests for expired tiles directly -.br +.BR 2) Delete tiles: Render_expired can delete expired tiles from disk. The next time the tile then gets viewed it will get re-rendered, assuming a dynamic rendering setup like mod_tile is installed -.br +.BR 3) Mark tiles as dirty: A dynamic tile rendering system like mod_tile decides if a tile needs re-rendering by comparing the timestamp of the tile with the time of the planet-import-complet timestamp. Render_expired can set the timestamp of a tile back many years, ensuring it is older than the db import time, thus causeing the tile to be considered dirty and in need for re-render. .PP These three strategies can be combined and applied at different zoom levels. E.g. Zoom level 17-18 get deleted, z11 - z16 get marked dirty and z6 - z10 get rendered directly. .PP Render_expired takes a list of tiles from stdin which should be expired. The format of the list is one tile per line specified as z/x/y. -.br +.BR 1/0/1 -.br +.BR 1/1/1 -.br +.BR 1/0/0 -.br +.BR 1/1/0 .PP render_expired will automatically expand the list to cover the effected tiles at other zoom levels. .PP + .SH OPTIONS This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). @@ -74,10 +78,11 @@ Print out a help text for render_expired \fB\-V\fR|\-\-version Print out the version number for render_expired .PP + .SH SEE ALSO -.BR renderd (1), -.BR mod_tile (1). -.br +.BR renderd(1) +.BR + .SH AUTHOR render_expire was written by OpenStreetMap project members. .PP diff --git a/docs/man/render_list.1 b/docs/man/render_list.1 index 2d790f4f..79a6c9bf 100644 --- a/docs/man/render_list.1 +++ b/docs/man/render_list.1 @@ -1,11 +1,14 @@ -.TH RENDER_LIST 1 "May 21, 2022" +.TH RENDER_LIST "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME render_list \- renders a list of map tiles by sending requests to a rendering daemon. + .SH SYNOPSIS .B render_list .RI [ options ] < "render.list" -.br +.BR + .SH DESCRIPTION This manual page briefly documents the .B render_list @@ -14,6 +17,7 @@ command. .B render_list is a helper utility that takes a list of map tiles from stdin and sends the requests to a rendering daemon .PP + .SH OPTIONS This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). @@ -47,29 +51,29 @@ Filter input to only render tiles greater or equal to this zoom level (default i Filter input to only render tiles less than or equal to this zoom level (default is 20). .PP If you are using --all, you can restrict the tile range by adding these options: -.br +.BR -x, --min-x=X minimum X tile coordinate -.br +.BR -X, --max-x=X maximum X tile coordinate -.br +.BR -y, --min-y=Y minimum Y tile coordinate -.br +.BR -Y, --max-y=Y maximum Y tile coordinate .PP Without --all, send a list of tiles to be rendered from STDIN in the format: -.br +.BR X Y Z -.br +.BR e.g. -.br +.BR 0 0 1 -.br +.BR 0 1 1 -.br +.BR 1 0 1 -.br +.BR 1 1 1 -.br +.BR The above would cause all 4 tiles at zoom 1 to be rendered .TP \fB\-h\fR|\-\-help @@ -78,10 +82,11 @@ Print out a help text for render_list \fB\-V\fR|\-\-version Print out the version number for render_list .PP + .SH SEE ALSO -.BR renderd (8), -.BR mod_tile (1). -.br +.BR renderd(1) +.BR + .SH AUTHOR render_list was written by OpenStreetMap project members. .PP diff --git a/docs/man/render_old.1 b/docs/man/render_old.1 index e597ca30..55433d20 100644 --- a/docs/man/render_old.1 +++ b/docs/man/render_old.1 @@ -1,11 +1,14 @@ -.TH RENDER_OLD 1 "Mar 28, 2013" +.TH RENDER_OLD "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME render_old \- renders a list of map tiles by sending requests to a rendering daemon. + .SH SYNOPSIS .B render_list .RI [ options ] < "render.list" -.br +.BR + .SH DESCRIPTION This manual page documents briefly the .B render_old @@ -14,10 +17,11 @@ command. .B render_old is a helper utility that pre renders expired map tiles by sending appropriate requests to a rendering daemon .PP + .SH SEE ALSO -.BR renderd (8), -.BR mod_tile (1). -.br +.BR renderd(1) +.BR + .SH AUTHOR render_expire was written by OpenStreetMap project members. .PP diff --git a/docs/man/render_speedtest.1 b/docs/man/render_speedtest.1 index c55eb363..9a26315b 100644 --- a/docs/man/render_speedtest.1 +++ b/docs/man/render_speedtest.1 @@ -1,10 +1,13 @@ -.TH RENDER_SPEEDTEST 1 "Jun 03, 2022" +.TH RENDER_SPEEDTEST "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME render_speedtest \- Benchmark tile rendering with renderd. + .SH SYNOPSIS .B render_speedtest .RI [ options ] + .SH DESCRIPTION This manual page documents briefly the .B render_speedtest @@ -13,6 +16,7 @@ command. .B render_speedtest renders a bunch of tiles at various zoom levels to benchmark the speed of the rendering. .PP + .SH OPTIONS These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). @@ -39,9 +43,11 @@ Print out a help text for render_speedtest \fB\-V\fR|\-\-version Print out the version number for render_speedtest .PP + .SH SEE ALSO -.BR renderd (1), -.br +.BR renderd(1) +.BR + .SH AUTHOR render_speedtest was written by Jon Burgess and other OpenStreetMap project members. diff --git a/docs/man/renderd.1 b/docs/man/renderd.1 index a40b377b..be703b30 100644 --- a/docs/man/renderd.1 +++ b/docs/man/renderd.1 @@ -1,11 +1,14 @@ -.TH RENDERD 1 "May 21, 2022" +.TH RENDERD "1" "2023-12-08" "mod_tile v0.6.1" .\" Please adjust this date whenever revising the manpage. + .SH NAME renderd \- Rendering daemon for rendering OpenStreetMap tiles. + .SH SYNOPSIS .B renderd .RI [ options ] -.br +.BR + .SH DESCRIPTION This manual page documents briefly the .B renderd @@ -17,6 +20,7 @@ on a socket. Renderd queues requests in a number of different queues to manage l rendering the requests with the mapnik library. By default renderd will start as a daemon. It will log information in the syslog. .PP + .SH OPTIONS This programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). @@ -40,9 +44,11 @@ Print out a help text for renderd \fB\-V\fR|\-\-version Print out the version number for renderd .PP + .SH SEE ALSO -.BR renderd.conf (1), -.br +.BR renderd.conf(5) +.BR + .SH AUTHOR renderd was written by Jon Burgess, and other OpenStreetMap project members. .PP diff --git a/docs/man/renderd.conf.5 b/docs/man/renderd.conf.5 new file mode 100644 index 00000000..2364864b --- /dev/null +++ b/docs/man/renderd.conf.5 @@ -0,0 +1,208 @@ +.TH RENDERD.CONF 5 "2023-12-08" "mod_tile v0.6.1" +.\" Please adjust this date whenever revising the manpage. + +.SH NAME +renderd.conf \- Configuration file of rendering daemon for rendering OpenStreetMap tiles. + +.SH SYNOPSIS +renderd.conf + +.SH DESCRIPTION +This manual page documents briefly the \fBrenderd.conf\fR configuration file. +.PP +\fBrenderd.conf\fR is an INI configuration file for use with \fBrenderd(1)\fR. +.PP +The default location is \fB'/etc/renderd.conf'\fR (macro definition \fB'RENDERD_CONFIG'\fR). +.PP +All option names are \fBcase-insensitive\fR unless otherwise specified. + + +.SH RENDERD +Options belonging to a \fB[renderd]\fR section. +.PP +There must be at least one \fB[renderd]\fR section (e.g. \fB[renderd]\fR or \fB[renderd0]\fR). +.PP +By default, there can be up to \fB5\fR (macro definition \fB'MAX_SLAVES'\fR) \fB[renderd]\fR sections (e.g. \fB[renderd0]\fR - \fB[renderd4]\fR). +.PP +\fB[renderd]\fR section names must begin with \fB[renderd]\fR. + +.TP +.B iphostname +Specify the IP address/hostname to be used for communication with \fBrenderd\fR. +This must be specified in combination with \fBipport\fR. +This option and \fBsocketname\fR are mutually exclusive. + +.TP +.B ipport +Specify the port number to be used for communication with \fBrenderd\fR. +This must be specified in combination with \fBiphostname\fR. +This option and \fBsocketname\fR are mutually exclusive. + +.TP +.B num_threads +Specify the number of threads to be used for \fBrenderd\fR. +The default value is \fB'4'\fR (macro definition \fB'NUM_THREADS'\fR). + +.TP +.B pid_file +Specify the file path into which the PID will be written by \fBrenderd\fR. +It is only written to when \fBrenderd\fR is not running in \fBforeground\fR mode (e.g. without \fB'--foreground'\fR / \fB'-f')\fR. +The default value is \fB'/var/run/renderd/renderd.pid'\fR (macro definition \fB'RENDERD_PIDFILE'\fR). + +.TP +.B socketname +Specify the file path to be used as a unix domain socket for communication with \fBrenderd\fR. +This option and \fBiphostname\fR / \fBipport\fR are mutually exclusive. +The default value is \fB'/var/run/renderd/renderd.sock'\fR (macro definition \fB'RENDERD_SOCKET'\fR). + +.TP +.B stats_file +Specify the file path into which statistics will be written by \fBrenderd\fR. +By default, a stats file will not be created. + +.TP +.B tile_dir +Specify the directory path into which tiles will be written by \fBrenderd\fR. +The default value is \fB'/var/cache/renderd/tiles'\fR (macro definition \fB'RENDERD_TILE_DIR'\fR). + + +.SH MAPNIK +Options belonging to the \fB[mapnik]\fR section. +.PP +There can be only one \fB[mapnik]\fR section. +.PP +\fB[mapnik]\fR section name must be equal to \fB[mapnik]\fR. + +.TP +.B font_dir +Specify the directory path where fonts are searched for by \fBlibmapnik\fR. +The default value is the output of \fB'mapnik-config --fonts'\fR / \fB'pkgconf --variable=fonts_dir libmapnik'\fR (macro definition \fB'MAPNIK_FONTS_DIR'\fR). + +.TP +.B font_dir_recurse +Specify whether or not to recurse the \fBfont_dir\fR when searching for fonts by \fBlibmapnik\fR. +The default value is \fB'false'\fR / \fB'0'\fR (macro definition \fB'MAPNIK_FONTS_DIR_RECURSE'\fR). + +.TP +.B plugins_dir +Specify the directory path where input plugins are searched for by \fBlibmapnik\fR. +The default value is the output of \fB'mapnik-config --input-plugins'\fR / \fB'pkgconf --variable=plugins_dir libmapnik'\fR (macro definition \fB'MAPNIK_PLUGINS_DIR'\fR). + + +.SH MAP SECTION +Options belonging a \fB[map]\fR section. +.PP +There must be at least one \fB[map]\fR section. +.PP +\fB[map]\fR section names can neither begin with \fB[renderd]\fR nor be equal to \fB[mapnik]\fR. +.PP +\fB[map]\fR section names can be anything else, but they must all be unique. + +.TP +.B ASPECTX +Specify the X aspect to be used by \fBmod_tile\fR. +Only used by \fBmod_tile\fR. +The default value is \fB'1'\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B ASPECTY +Specify the Y aspect to be used by \fBmod_tile\fR. +Only used by \fBmod_tile\fR. +The default value is \fB'1'\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B ATTRIBUTION +Specify the data attribution to be provided by \fBmod_tile\fR as \fBTileJSON\fR (via \fB{URI}/tile-layer.json\fR). +Only used by \fBmod_tile\fR. +The default value is \fB'©OpenStreetMap and contributors, (ODbL)'\fR (macro definition \fB'DEFAULT_ATTRIBUTION'\fR). +This option name is \fBcase-sensitive\fR. + +.TP +.B CORS +Specify the CORS configuration for \fBmod_tile\fR. +Only used by \fBmod_tile\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B DESCRIPTION +Specify the description to be provided by \fBmod_tile\fR as \fBTileJSON\fR (via \fB{URI}/tile-layer.json\fR). +Only used by \fBmod_tile\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B htcphost +Specify the IP address/hostname of the HTCP Host to be used by \fBrenderd\fR for HTCP cache expiry. +Only used by \fBrenderd\fR. + +.TP +.B host +Specify the IP address/hostname of the Host to be used by \fBrenderd\fR for HTCP cache expiry. +Only used by \fBrenderd\fR. + +.TP +.B MAXZOOM +Specify the maximum zoom level for this section. +The default value is \fB'20'\fR (macro definition \fB'MAX_ZOOM'\fR). +This option name is \fBcase-sensitive\fR. + +.TP +.B MINZOOM +Specify the minimum zoom level for this section. +The default value is \fB'0'\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B PARAMETERIZE_STYLE +Specify the parameterization style/function to be used for this section. +The value of \fB'language'\fR seems to be the only one supported. +This option name is \fBcase-sensitive\fR. + +.TP +.B SERVER_ALIAS +Specify a URL alias of this server to be provided by \fBmod_tile\fR as \fBTileJSON\fR (via \fB{URI}/tile-layer.json\fR). +Only used by \fBmod_tile\fR. +This option name is \fBcase-sensitive\fR. + +.TP +.B scale +Specify the scale for this section. +Only used by \fBrenderd\fR. +The default value is \fB'1.0'\fR. + +.TP +.B TILEDIR +Specify the directory path into which tiles will be written by \fBrenderd\fR. +The default value is \fB'/var/cache/renderd/tiles'\fR (macro definition \fB'RENDERD_TILE_DIR'\fR). +This option name is \fBcase-sensitive\fR. + +.TP +.B tilesize +Specify the tile size for this section. +Only used by \fBrenderd\fR. +The default value is \fB'256'\fR. + +.TP +.B TYPE +Specify the tile configuration (in the format \fB' '\fR) for this section (e.g. \fB'png image/png png256'\fR). +This option name is \fBcase-sensitive\fR. + +.TP +.B URI +Specify the URI prefix with which tiles can be accessed for this section. +This option name is \fBcase-sensitive\fR. + +.TP +.B xml +Specify the file path of the Mapnik configuration XML file for this section. +Only used by \fBrenderd\fR. + +.SH SEE ALSO +.BR renderd(1) +.BR + +.SH AUTHOR +renderd was written by Jon Burgess, and other OpenStreetMap project members. +.PP +This manual page was written by OpenStreetMap authors. \ No newline at end of file