summaryrefslogtreecommitdiffstats
path: root/tools/man1/qsrotate.1
diff options
context:
space:
mode:
Diffstat (limited to 'tools/man1/qsrotate.1')
-rw-r--r--tools/man1/qsrotate.150
1 files changed, 50 insertions, 0 deletions
diff --git a/tools/man1/qsrotate.1 b/tools/man1/qsrotate.1
new file mode 100644
index 0000000..754e8f4
--- /dev/null
+++ b/tools/man1/qsrotate.1
@@ -0,0 +1,50 @@
+.TH QSROTATE 1 "May 2023" "mod_qos utilities 11.74" "qsrotate man page"
+
+.SH NAME
+qsrotate \- a log rotation tool (similar to Apache's rotatelogs).
+.SH SYNOPSIS
+qsrotate \-o <file> [\-s <sec> [\-t <hours>]] [\-b <bytes>] [\-f] [\-z] [\-g <num>] [\-u <name>] [\-m <mask>] [\-p] [\-d]
+.SH DESCRIPTION
+qsrotate reads from stdin (piped log) and writes the data to the provided file rotating the file after the specified time.
+.SH OPTIONS
+.TP
+\-o <file>
+Output log file to write the data to (use an absolute path).
+.TP
+\-s <sec>
+Rotation interval in seconds, default are 86400 seconds.
+.TP
+\-t <hours>
+Offset to UTC (enables also DST support), default is 0.
+.TP
+\-b <bytes>
+File size limitation (default/max. are 2147352576 bytes, min. are 1048576 bytes).
+.TP
+\-f
+Forced log rotation at the specified interval even no data is written.
+.TP
+\-z
+Compress (gzip) the rotated file.
+.TP
+\-g <num>
+Generations (number of files to keep).
+.TP
+\-u <name>
+Become another user, e.g. www\-data. \-m <mask>
+File permission which is either 600, 640, 660 (default) or 664.
+.TP
+\-p
+Writes data also to stdout (for piped logging). \-d
+Line\-by\-line data reading prefixing every line with a timestamp.
+.SH EXAMPLE
+ TransferLog "|/usr/bin/qsrotate \-f \-z \-g 3 \-o /var/log/apache/access.log \-s 86400"
+
+The name of the rotated file will be /dest/filee.YYYYmmddHHMMSS where YYYYmmddHHMMSS is the system time at which the data has been rotated.
+.SH NOTE
+ \- Each qsrotate instance must use an individual file.
+ \- You may trigger a file rotation manually by sending the signal USR1
+to the process.
+.SH SEE ALSO
+qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qsre(1), qsrespeed(1), qspng(1), qssign(1), qstail(1)
+.SH AUTHOR
+Pascal Buchbinder, http://mod-qos.sourceforge.net/