.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .\" ======================================================================== .\" .IX Title "TIREX-TILEDIR-CHECK 1" .TH TIREX-TILEDIR-CHECK 1 2024-05-06 "perl v5.38.2" "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\-tiledir\-check \- check tile dir .SH SYNOPSIS .IX Header "SYNOPSIS" tirex-tiledir-check [OPTIONS] MAP .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-h\fR, \fB\-\-help\fR" 8 .IX Item "-h, --help" Display help message. .IP "\fB\-c\fR, \fB\-\-config=DIR\fR" 8 .IX Item "-c, --config=DIR" Use the config directory DIR instead of /etc/tirex. .IP "\fB\-l\fR, \fB\-\-list=FILE\fR" 8 .IX Item "-l, --list=FILE" Write list of tiles to FILE. See below for format. .IP "\fB\-s\fR, \fB\-\-stats=FILE\fR" 8 .IX Item "-s, --stats=FILE" Write stats about tiles to FILE. See below for format. .IP "\fB\-z\fR, \fB\-\-minz=i\fR" 8 .IX Item "-z, --minz=i" Start processing at min. zoom level i (default=0) .IP "\fB\-Z\fR, \fB\-\-maxz=i\fR" 8 .IX Item "-Z, --maxz=i" Stop processing at max. zoom level i (default=19) .SH DESCRIPTION .IX Header "DESCRIPTION" Walks recursively through the tiles directory for the given MAP and checks for wrong directory or file names or files that can't be accessed. If problems are found, messages are written to STDERR. .PP When the \-\-list and/or \-\-stats options are given, it outputs information about each tile and/or generates statistics, respectively. The list and stats are written to the filenames given, if you give '\-' as the filename STDOUT is used. You can only use STDOUT for either the list file or the stats file. .PP Caution: This command will go through all metatiles on your disk and stat each file. On a lightly loaded machine with lots of RAM this can go pretty quick, but under high IO loads it might take a long time. Take this into account if you want to run it regularly from cron or similar. .SH "LIST FILE FORMAT" .IX Header "LIST FILE FORMAT" The list file is in CSV format with one line per metatile. The fields are: .IP age 8 .IX Item "age" Age of metatile in seconds. .IP size 8 .IX Item "size" Size in bytes of the metatile. .IP blocks 8 .IX Item "blocks" Number of blocks used for this metatile. .IP metatile 8 .IX Item "metatile" Description of metatile. Format: map=foo x=8 y=0 z=10 .PP This data can be read with other programs to create statistics etc. .SH "STATS FILE FORMAT" .IX Header "STATS FILE FORMAT" The stats file is in JSON format. It contains a hash with the names of all maps as keys and a list of zoom levels as their values. For each zoom level there is a nested hash containing the statistics: .IP "count \- Number of tiles" 8 .IX Item "count - Number of tiles" .PD 0 .IP "maxage \- Maximum age in seconds" 8 .IX Item "maxage - Maximum age in seconds" .IP "maxblocks \- Maximum number of blocks" 8 .IX Item "maxblocks - Maximum number of blocks" .IP "maxsize \- Maximum file size in bytes" 8 .IX Item "maxsize - Maximum file size in bytes" .IP "minage \- Minimum age in seconds" 8 .IX Item "minage - Minimum age in seconds" .IP "minblocks \- Minimum number of blocks" 8 .IX Item "minblocks - Minimum number of blocks" .IP "minsize \- Minimum file size in bytes" 8 .IX Item "minsize - Minimum file size in bytes" .IP "sumage \- Sum of ages in seconds" 8 .IX Item "sumage - Sum of ages in seconds" .IP "sumblocks \- Sum of number of blocks" 8 .IX Item "sumblocks - Sum of number of blocks" .IP "sumsize \- Sum of file size in bytes" 8 .IX Item "sumsize - Sum of file size in bytes" .PD .PP The sumage, sumblocks, and sumsize values can be divided by count to get the average. .PP This file can be displayed on a human readable format with the Program tirex-tiledir-stat. It is also read by several Munin plugins. .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 if no errors were found or 1 if there were errors. If there were errors parsing the command line 2 is returned. .SH "SEE ALSO" .IX Header "SEE ALSO" .SH AUTHORS .IX Header "AUTHORS" Frederik Ramm , Jochen Topf and possibly others.