Skip to content

Commit

Permalink
Update man pages to reflect recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
hummeltech authored and ǝɹʇʇɐʃǝ◖ xıʃǝɟ committed May 26, 2022
1 parent 9d34dd8 commit fe17e56
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 11 deletions.
14 changes: 10 additions & 4 deletions docs/man/render_expired.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH RENDER_EXPIRED 1 "Jan 27, 2012"
.TH RENDER_EXPIRED 1 "May 21, 2022"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
render_expired \- expires a list of map tiles so that they get re-rendered.
Expand Down Expand Up @@ -43,14 +43,14 @@ A summary of options is included below.
\fB\-m\fR|\-\-map=MAP
Specify the style-sheet for which to expire tiles. The default is "default".
.TP
\fB\-s\fR|\-\-socket=SOCKET
Specify the location of the renderd socket.
\fB\-s\fR|\-\-socket=SOCKET|HOSTNAME:PORT
Specify the location of the renderd socket or hostname and port to connect to.
.TP
\fB\-n\fR|\-\-num-threads=N
Specify the number of parallel requests to renderd. Should renderd have less threads active, requests will be queued. The default is 1.
default if \fB\-\-append\fR is not specified.
.TP
\fB\-t\fR|\-\-tiledir=DIR
\fB\-t\fR|\-\-tile-dir=DIR
Specify the base directory where the rendered tiles are. The default is '/var/cache/renderd/tiles'
.TP
\fB\-z\fR|\-\-min-zoom=ZOOM
Expand All @@ -64,6 +64,12 @@ When expiring tiles of ZOOM or higher, delete them instead of re-rendering (defa
.TP
\fB\-T\fR|\-\-touch-from=ZOOM
when expiring tiles of ZOOM or higher, touch them instead of re-rendering (default is off)
.TP
\fB\-h\fR|\-\-help
Print out a help text for render_expired
.TP
\fB\-V\fR|\-\-version
Print out the version number for render_expired
.PP
.SH SEE ALSO
.BR renderd (1),
Expand Down
13 changes: 10 additions & 3 deletions docs/man/render_list.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH RENDER_LIST 1 "Apr 25, 2013"
.TH RENDER_LIST 1 "May 21, 2022"
.\" 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.
Expand Down Expand Up @@ -31,8 +31,8 @@ Render tiles in this map (defaults to 'default').
\fB\-l\fR|\-\-max-load=LOAD
Sleep if load is this high (defaults to 16).
.TP
\fB\-s\fR|\-\-socket=SOCKET
Unix domain socket name for contacting renderd.
\fB\-s\fR|\-\-socket=SOCKET|HOSTNAME:PORT
Unix domain socket name or hostname and port for contacting renderd.
.TP
\fB\-n\fR|\-\-num-threads=N
The number of parallel request threads (default 1).
Expand Down Expand Up @@ -71,6 +71,13 @@ e.g.
1 1 1
.br
The above would cause all 4 tiles at zoom 1 to be rendered
.TP
\fB\-h\fR|\-\-help
Print out a help text for render_list
.TP
\fB\-V\fR|\-\-version
Print out the version number for render_list
.PP
.SH SEE ALSO
.BR renderd (8),
.BR mod_tile (1).
Expand Down
15 changes: 12 additions & 3 deletions docs/man/render_speedtest.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH SPEEDTEST 1 "Jan 25, 2012"
.TH SPEEDTEST 1 "May 21, 2022"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
speedtest \- Benchmapr tile rendering with renderd.
Expand All @@ -18,11 +18,20 @@ 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
Specify the location of the renderd socket to connect to.
\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\-h\fR|\-\-help
Print out a help text for speedtest
.TP
\fB\-V\fR|\-\-version
Print out the version number for speedtest
.PP
.SH SEE ALSO
.BR renderd (1),
Expand Down
5 changes: 4 additions & 1 deletion docs/man/renderd.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH RENDERD 1 "Jan 25, 2012"
.TH RENDERD 1 "May 21, 2022"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
renderd \- Rendering daemon for rendering OpenStreetMap tiles.
Expand Down Expand Up @@ -36,6 +36,9 @@ of renderd. The default is to use the master section
.TP
\fB\-h\fR|\-\-help
Print out a help text for renderd
.TP
\fB\-V\fR|\-\-version
Print out the version number for renderd
.PP
.SH SEE ALSO
.BR renderd.conf (1),
Expand Down

0 comments on commit fe17e56

Please sign in to comment.