Add man page for renderd.conf (#357)

* Update AUTHORS file
* Add renderd.conf man to CMakeLists.txt & Makefile.am
* Minor updates to other man pages as well

Author: hummeltech

AUTHORS

@@ -1,6 +1,7 @@
 Ævar Arnfjörð Bjarmason <[email protected]>
-Anton Belichkov <[email protected]>
+Amanda <[email protected]>
 Andreas Hubel <[email protected]>
+Anton Belichkov <[email protected]>
 Bas Couwenberg <[email protected]>
 Ben Hosmer <[email protected]>
 Ben Kochie <[email protected]>
@@ -22,6 +23,7 @@ Lennard voor den Dag <[email protected]>
 Manfred Stock <[email protected]>
 Matt Amos <[email protected]>
 Michael Fazio <[email protected]>
+Michael Schmiedgen <[email protected]>
 Moritz Seemann <[email protected]>
 Paul Norman <[email protected]>
 Peter Körner <[email protected]>
@@ -30,8 +32,11 @@ Ramunas <[email protected]>
 Robert Buchholz <[email protected]>
 rusvdw <[email protected]>
 Sean Reifschneider <[email protected]>
+SomeoneElseOSM <[email protected]>
+Stephan Austermühle <[email protected]>
 Stephan Knauss <[email protected]>
 Stephan Plepelits <[email protected]>
 Tom Hughes <[email protected]>
+vholten <[email protected]>
 Xin Yu <[email protected]>
 Zverik <[email protected]>

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()
 
 #-----------------------------------------------------------------------------

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 \

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.

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

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

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

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

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.

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