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
This commit is contained in:
Hummeltech
2023-12-12 13:44:23 -07:00
committed by GitHub
parent 8abe6eed6d
commit 8e3e8fb34f
11 changed files with 305 additions and 50 deletions

View File

@ -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