Skip to content

Commit

Permalink
Update man pages for render_expired/render_list (#403)
Browse files Browse the repository at this point in the history
_Also updated all render\_* apps to_:
* Use `MAX_ZOOM` rather than hard-coded values for `--max-zoom`
* Print `metatile` rather than `meta tile`
* Add missing `--help` output to `render_expired` & `render_list`
* Remove redundant `--help` output from `render_list`
  • Loading branch information
hummeltech authored Mar 8, 2024
1 parent dd90553 commit c9e7dd8
Show file tree
Hide file tree
Showing 7 changed files with 167 additions and 95 deletions.
36 changes: 25 additions & 11 deletions docs/man/render_expired.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH RENDER_EXPIRED "1" "2023-12-19" "mod_tile v0.7.0"
.TH RENDER_EXPIRED "1" "2024-03-08" "mod_tile v0.7.0"
.\" 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"
.RI [ options ]\ <\ "expire.list"
.BR

.SH DESCRIPTION
Expand All @@ -27,13 +27,13 @@ Render_expired has three potential strategies of how to expire map tiles:
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
.sp 0
1/0/1
.BR
.sp 0
1/1/1
.BR
.sp 0
1/0/0
.BR
.sp 0
1/1/0
.PP
render_expired will automatically expand the list to cover the effected tiles at other zoom levels.
Expand All @@ -44,6 +44,21 @@ This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
\fB\-c\fR|\-\-config=CONFIG
Specify a `renderd.conf` file from which to load various option values rather than specifying via command line.
.sp 0
The following options will be set (if present); however, they can be overridden if also specified:
.sp 0
\fB\-s\fR|\-\-socket
.sp 0
\fB\-n\fR|\-\-num-threads
.sp 0
\fB\-t\fR|\-\-tile-dir
.sp 0
\fB\-z\fR|\-\-min-zoom
.sp 0
\fB\-Z\fR|\-\-max-zoom
.TP
\fB\-m\fR|\-\-map=MAP
Specify the style-sheet for which to expire tiles. The default is "default".
.TP
Expand All @@ -52,24 +67,23 @@ 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|\-\-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
Filter input to only render tiles greater or equal to this zoom level (default is 0)
Filter input to only render tiles greater than or equal to this zoom level (default is '0').
.TP
\fB\-Z\fR|\-\-max-zoom=ZOOM
Filter input to only render tiles less than or equal to this zoom level (default is 18)
Filter input to only render tiles less than or equal to this zoom level (default is '20').
.TP
\fB\-d\fR|\-\-delete-from=ZOOM
When expiring tiles of ZOOM or higher, delete them instead of re-rendering (default is off)
.TP
\fB\-T\fR|\-\-touch-from=ZOOM
when expiring tiles of ZOOM or higher, touch them instead of re-rendering (default is off)
When expiring tiles of ZOOM or higher, touch them instead of re-rendering (default is off)
.TP
\-\-no-progress
\fB\-N\fR|\-\-no-progress
Disable display of progress messages (default is off)
.TP
\fB\-h\fR|\-\-help
Expand Down
67 changes: 41 additions & 26 deletions docs/man/render_list.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH RENDER_LIST "1" "2024-02-06" "mod_tile v0.7.0"
.TH RENDER_LIST "1" "2024-03-08" "mod_tile v0.7.0"
.\" 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"
.RI [ options ]\ <\ "render.list"
.BR

.SH DESCRIPTION
Expand All @@ -26,43 +26,64 @@ A summary of options is included below.
\fB\-a\fR|\-\-all
Render all tiles in given zoom level range instead of reading from STDIN.
.TP
\fB\-c\fR|\-\-config=CONFIG
Specify a `renderd.conf` file from which to load various option values rather than specifying via command line.
.sp 0
The following options will be set (if present); however, they can be overridden if also specified:
.sp 0
\fB\-s\fR|\-\-socket
.sp 0
\fB\-n\fR|\-\-num-threads
.sp 0
\fB\-t\fR|\-\-tile-dir
.sp 0
\fB\-z\fR|\-\-min-zoom
.sp 0
\fB\-Z\fR|\-\-max-zoom
.TP
\fB\-f\fR|\-\-force
Render tiles even if they seem current.
.TP
\fB\-m\fR|\-\-map=MAP
Render tiles in this map (defaults to 'default').
Render tiles in this map (default is 'default').
.TP
\fB\-l\fR|\-\-max-load=LOAD
Sleep if load is this high (defaults to 16).
Sleep if load is this high (default is '16').
.TP
\fB\-s\fR|\-\-socket=SOCKET|HOSTNAME:PORT
Unix domain socket name or hostname and port for contacting renderd.
Unix domain socket name or hostname and port for contacting renderd (default is '/var/run/renderd/renderd.sock').
.TP
\fB\-n\fR|\-\-num-threads=N
The number of parallel request threads (default 1).
The number of parallel request threads (default is '1').
.TP
\fB\-t\fR|\-\-tile-dir
Tile cache directory (defaults to '/var/cache/renderd/tiles').
\fB\-t\fR|\-\-tile-dir=TILE_DIR
Tile cache directory (default is '/var/cache/renderd/tiles').
.TP
\fB\-z\fR|\-\-min-zoom=ZOOM
Filter input to only render tiles greater or equal to this zoom level (default is 0).
Filter input to only render tiles greater than or equal to this zoom level (default is '0').
.TP
\fB\-Z\fR|\-\-max-zoom=ZOOM
Filter input to only render tiles less than or equal to this zoom level (default is 20).
Filter input to 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_list
.TP
\fB\-V\fR|\-\-version
Print out the version number for render_list
.PP
If you are using --all, you can restrict the tile range by adding these options:
.BR
(please note that tile coordinates must be positive integers and are not latitude and longitude values)
.BR
-x, --min-x=X minimum X tile coordinate
If you are using \fB\-a\fR|\-\-all, you can restrict the tile range by adding these options:
.sp 0
(please note that tile coordinates must be positive integers and are not latitude and longitude values)
.PP
\fB\-x\fR|\-\-min-x=X minimum X tile coordinate
.BR
-X, --max-x=X maximum X tile coordinate
\fB\-X\fR|\-\-max-x=X maximum X tile coordinate
.BR
-y, --min-y=Y minimum Y tile coordinate
\fB\-y\fR|\-\-min-y=Y minimum Y tile coordinate
.BR
-Y, --max-y=Y maximum Y tile coordinate
\fB\-Y\fR|\-\-max-y=Y maximum Y tile coordinate
.PP
Without --all, send a list of tiles to be rendered from STDIN in the format:
Without \fB\-a\fR|\-\-all, send a list of tiles to be rendered from STDIN in the format:
.BR
X Y Z
.BR
Expand All @@ -75,14 +96,8 @@ e.g.
1 0 1
.BR
1 1 1
.BR
.PP
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
Expand Down
Loading

0 comments on commit c9e7dd8

Please sign in to comment.