Files
mod_tile/docs/man/render_speedtest.1
Hummeltech 8e3e8fb34f 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
2023-12-12 13:44:23 -07:00

56 lines
1.4 KiB
Groff

.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
command.
.PP
.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 (`-').
A summary of options is included below.
.TP
\fB\-s\fR|\-\-socket=SOCKET|HOSTNAME:PORT
Specify the location of the renderd socket or hostname and port to connect to.
.TP
\fB\-m\fR|\-\-map=MAP
Specify the rendering style to test. The default is "default"
.TP
\fB\-n\fR|\-\-num-threads=N
The number of parallel request threads (default 1).
.TP
\fB\-z\fR|\-\-min-zoom=ZOOM
Only render tiles greater or equal to this zoom level (default is 0).
.TP
\fB\-Z\fR|\-\-max-zoom=ZOOM
Only render tiles less than or equal to this zoom level (default is 20).
.TP
\fB\-h\fR|\-\-help
Print out a help text for render_speedtest
.TP
\fB\-V\fR|\-\-version
Print out the version number for render_speedtest
.PP
.SH SEE ALSO
.BR renderd(1)
.BR
.SH AUTHOR
render_speedtest was written by Jon Burgess and other
OpenStreetMap project members.
.PP
This manual page was written by OpenStreetMap authors.