Remove wheel submodule - will re-add later with new URL
[dmon:dmon.git] / drlog.8
1 .\" Man page generated from reStructeredText.
2 .
3 .TH DRLOG 8 "" "" ""
4 .SH NAME
5 drlog \- Read lines from stdin and append them to auto-rotated logs
6 .
7 .nr rst2man-indent-level 0
8 .
9 .de1 rstReportMargin
10 \\$1 \\n[an-margin]
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13 -
14 \\n[rst2man-indent0]
15 \\n[rst2man-indent1]
16 \\n[rst2man-indent2]
17 ..
18 .de1 INDENT
19 .\" .rstReportMargin pre:
20 . RS \\$1
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
24 ..
25 .de UNINDENT
26 . RE
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32 ..
33 .SH SYNOPSIS
34 .sp
35 \fBdrlog [options] directory\fP
36 .SH DESCRIPTION
37 .sp
38 \fBdrlog\fP will read its standard input, distributing it as output in a set
39 of named \fBlog\-YYYY\-mm\-dd\-HH:MM:SS\fP and a \fBcurrent\fP file. Output is always
40 appended to \fBcurrent\fP, but when user\-defined maximum file size (\fB\-s\fP) or
41 file usage time (\fB\-t\fP) it will be renamed with a timestamp in its file name,
42 a new \fBcurrent\fP file will be opened and, if there are stored more than
43 a number of timestamped files (\fB\-m\fP) old ones will be deleted.
44 .sp
45 The names of the files are designed to make them appear time\-ordered in
46 output from commands like \fIls(1)\fP. Also, the \fBcurrent\fP file will appear at
47 the top of file listings.
48 .sp
49 If \fBdrlog\fP receives a \fITERM\fP signal, it will read and process data until
50 the next newline and then exit, leaving \fIstdin\fP at the first byte of data it
51 has not yet precessed.
52 .sp
53 Upon a \fBHUP\fP signal, \fBdrlog\fP will close and re\-open the \fBcurrent\fP
54 log file, just in case you want rotate logs using an external tool, though
55 using it that way is unsupported.
56 .SH USAGE
57 .sp
58 Command line options:
59 .INDENT 0.0
60 .TP
61 .BI \-m \ NUMBER, \ \-\-max\-files \ NUMBER
62 Maximum amount of maintained log files. When \fBdrlog\fP sees
63 more than \fINUMBER\fP log files in the log \fIdirectory\fP it will
64 remove the oldest log file.
65 .TP
66 .BI \-T \ TIME, \ \-\-max\-time \ TIME
67 Maximum number of time to use a log file. Once \fBdrlog\fP spends
68 more than \fITIME\fP using a log file it will start writing to a new
69 one. Suffixes \fIm\fP (minutes), \fIh\fP (hours), \fId\fP (days), \fIw\fP (weeks),
70 \fIM\fP (months) and \fIy\fP (years) may be used after the number. If no
71 suffix is given, it is assummed that \fITIME\fP is in seconds.
72 .TP
73 .BI \-s \ SIZE, \ \-\-max\-size \ SIZE
74 Maximum size of each log file. When a log file grows over
75 \fISIZE\fP then \fBdrlog\fP will rotate logs and open a new one.
76 Suffixes \fIk\fP (kilobytes), \fIm\fP (megabytes) and \fIg\fP (gigabytes)
77 may be used after the number. If no suffix is given, it is
78 assumed that \fBSIZE\fP is in bytes.
79 .TP
80 .B \-b,  \-\-buffered
81 Buffered operation. If enabled, calls to \fIfsync(2)\fP will be
82 avoided. This improves performance, but may cause messages to
83 be lost.
84 .TP
85 .B \-t,  \-\-timestamp
86 Prepend a timestamp to each line. The timestamp format
87 is \fBYYYY\-mm\-dd/HH:MM:SS\fP, following that of rotated log files.
88 It is easy to parse and sort. And human\-readable, too.
89 .UNINDENT
90 .SH SEE ALSO
91 .sp
92 \fImultilog(8)\fP, \fIsupervise(8)\fP, \fIsvc(8)\fP, \fIdslog(8)\fP, \fIdlog(8)\fP, \fIdmon(8)\fP
93 .SH AUTHOR
94 Adrian Perez <aperez@igalia.com>
95 .\" Generated by docutils manpage writer.
96 .\" 
97 .