.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TIREX-BATCH 1" .TH TIREX-BATCH 1 "2023-04-11" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" tirex\-batch \- send rendering requests to tirex master .SH "SYNOPSIS" .IX Header "SYNOPSIS" tirex-batch [\s-1OPTIONS\s0] [\s-1INIT\s0] .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-h\fR, \fB\-\-help\fR" 8 .IX Item "-h, --help" Display help message. .IP "\fB\-d\fR, \fB\-\-debug\fR" 8 .IX Item "-d, --debug" Run in debug mode. You'll see the actual messages sent and received. .IP "\fB\-c\fR, \fB\-\-config=DIR\fR" 8 .IX Item "-c, --config=DIR" Use the config directory \s-1DIR\s0 instead of /etc/tirex. .IP "\fB\-n\fR, \fB\-\-num=NUM\fR" 8 .IX Item "-n, --num=NUM" Try to keep the number of jobs in the queue below this number (Only checked once per second). Disable with NUM=0. .IP "\fB\-q\fR, \fB\-\-quit\fR" 8 .IX Item "-q, --quit" Quit if the number of jobs in the queue is higher than the number given with \-n. Without \-q, tirex-batch would wait, and continue to fill the queue once it has gone below the threshold. .IP "\fB\-p\fR, \fB\-\-prio=PRIO\fR" 8 .IX Item "-p, --prio=PRIO" Priority for requests. .IP "\fB\-e\fR, \fB\-\-expire=TIME\fR" 8 .IX Item "-e, --expire=TIME" Expire time (seconds since epoch) for jobs. If it starts with '+', number of seconds added to current time. .IP "\fB\-f\fR, \fB\-\-filter\fR" 8 .IX Item "-f, --filter" Add filters to metatile selection, see section \s-1FILTERS.\s0 .IP "\fB\-\-remove\fR" 8 .IX Item "--remove" Send remove request instead of rendering request. Jobs will be removed from the queue. .IP "\fB\-\-count\-only\fR" 8 .IX Item "--count-only" Only count how many metatiles would be rendered, do not actually send the requests. This will take the filters into account, so it will possibly check the disk for thousands of files! .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1INIT\s0 is a string describing a range of tiles. If no \s-1INIT\s0 string is given on the command line, tirex-batch reads init strings from \s-1STDIN,\s0 one per line. .PP Several different ways of describing the tiles are allowed: .PP Single metatile: map=foo x=4 y=7 z=15 (coordinates will be rounded to metatile numbers) .PP Multiple metatiles: map=foo x=0\-32 y=16\-32 z=15 .PP Using longitude and latitude ranges (8 to 9 degrees longitude, 48 to 49 degrees latitude) map=foo lon=8,9 lat=48,49 z=15\-17 .PP Using a bounding box (8 to 9 degrees longitude, 48 to 49 degrees latitude) map=foo bbox=8,48,9,49 z=15\-17 .PP Multiple maps are allowed, too: map=foo,bar .PP You can use a z range (z=10\-15). This does not work together with x and y ranges, but works with lon/lat ranges. .PP Ranges of x, y, and z numbers are written as \*(L"\s-1MIN,MAX\*(R"\s0 or \*(L"MIN-MAX\*(R". Ranges of lon and lat are written as \*(L"\s-1MIN,MAX\*(R"\s0 (lon and lat can be negative, so range with \*(L"\-\*(R" is problematic). .PP You can also just give a pathname of a metatile file as \s-1INIT\s0 string. It has to start with './' or '/'. The first directory component must be the name of the map. .SH "FILTERS" .IX Header "FILTERS" \&\s-1FILTER\s0 is a ;\-separated list of filter options. Metatiles not matching the filter are skipped. .PP Filter Options: .IP "\fBexists\fR" 8 .IX Item "exists" Matches if the meta tile exists on disk. .IP "\fBnot-exists\fR" 8 .IX Item "not-exists" Matches if the meta tile does not exist on disk. .IP "\fBolder(time)\fR" 8 .IX Item "older(time)" Matches if the meta tile's last modification time is before the given Unix time stamp (seconds since the epoch, 1970\-01\-01 00:00:00). Also matches if the meta tile does not exist on disk. If you want to match only files older than the given date which do actually exist, add the \fIexists\fR filter. .IP "\fBolder(filename)\fR" 8 .IX Item "older(filename)" Instead of the time in seconds since the epoch you can also enter a filename here. The mtime (last modified) of this file will be used. tirex-batch will exit with return code 2 if the file does not exist. .IP "\fBnewer(time)\fR" 8 .IX Item "newer(time)" Matches if the meta tile's last modification time is after the given Unix time stamp (seconds since the epoch, 1970\-01\-01 00:00:00). Also matches if the meta tile does not exist on disk. If you want to match only files newer than the given date which do actually exist, add the \fIexists\fR filter. .IP "\fBnewer(filename)\fR" 8 .IX Item "newer(filename)" Instead of the time in seconds since the epoch you can also enter a filename here. The mtime (last modified) of this file will be used. tirex-batch will exit with return code 2 if the file does not exist. .IP "\fBmulti(count,num)\fR" 8 .IX Item "multi(count,num)" A magic filter that divides all meta tiles up in \fIcount\fR classes, and matches only if the current meta tile is in class \fInum\fR of these. Hence the allowed range for \fInum\fR is always 0..\fIcount\fR\-1. Currently only \&\fIcount\fR=2 is supported. This filter can be used to distribute rendering requests among different tile servers (which may or may not then use \&\fItirex-syncd\fR to share resulting tiles). .SH "FILES" .IX Header "FILES" .IP "\fI/etc/tirex/tirex.conf\fR" 8 .IX Item "/etc/tirex/tirex.conf" The configuration file. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" Returns 0 on success, 1 if there was a problem sending the request and 2 if there was a problem parsing the command line or init string. .SH "SEE ALSO" .IX Header "SEE ALSO" .SH "AUTHORS" .IX Header "AUTHORS" Frederik Ramm , Jochen Topf and possibly others.