File: rrdcollect.man

package info (click to toggle)
rrdcollect 0.2.10-2
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, buster, jessie, jessie-kfreebsd, sid, stretch, wheezy
  • size: 708 kB
  • ctags: 186
  • sloc: ansic: 2,330; sh: 1,373; makefile: 121
file content (98 lines) | stat: -rw-r--r-- 2,645 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
.TH RRDCOLLECT 8 "RRDcollect !VERSION!" "2 September 2002" "RRDcollect"
.SH NAME
RRDcollect  --  Round-Robin Database Collecting Daemon.
.SH SYNOPSIS
\fBrrdcollect\fR [\fIoption\fR]...

.SH DESCRIPTION
The \fBrrdcollect\fR daemon is responsible for fetching statistical
data from various soures (listed in \fBrrdcollect.conf\fR),
typically files under \fB/proc/\fR directory.  It periodically
reads them and searches for patterns from configuration file.
Values are then stored inside \fBrrdtool\fR's \fI.rrd\fR files.

.SH OPTIONS
RRDcollect follows the usual GNU command line syntax, with long
options starting with two dashes (`-').

.SS General options
.IP "\fB\-c\fR \fIfile\fR" 4
.PD 0
.IP "\fB\-\-config=\fIfile\fR" 4
.PD
Specifies which \fIfile\fR should be read instead of default config file.

.IP "\fB\-n\fR" 4
.PD 0
.IP "\fB\-\-no\-fork\fR" 4
.PD
Program will not fork.  Very useful when testing or debugging.

.IP "\fB\-v\fB" 4
.PD 0
.IP "\fB\-\-verbose\fR" 4
.PD
Increase verbosity.  This option also implies \fB\-\-no\-fork\fR, since
you probably don't want RRDcollect in daemon mode trashing your terminal.

.SS RRD update options

.IP "\fB\-o\fR \fIfile\fR" 4
.PD 0
.IP "\fB\-\-output=\fIfile\fR" 4
Specifies \fIfile\fR to which \fIrrdtool\fR(1)-style commands should
be written.  If \fIfile\fR you specify is `\fB-\fR' (hyphen), then commans
are written to standard output (this case implies \fB\-\-no\-fork\fR).

.IP "\fB\-p\fR" 4
.PD 0
.IP "\fB\-\-pipe\fR" 4
.PD 0
.IP "\fB\-\-pipe=\fIprogram\fR" 4
.PD
When this option is used, RRDcollect will open pipe to \fIrrdtool\fR(1)
program and send it update commands.  If you don't give \fIprogram\fR,
the compiled-in default is assumed (either `\fBrrdtool - >/dev/null\fR'
or full path to \fIrrdtool\fR(1) binary).  The \fIprogram\fR option
can be specified as a full path or just a command name, in the latter
case the program should reside on \fBPATH\fR.

.PP
If no RRD update option is given, RRDcollect uses internal librrd routines
(the preferred mode of operation).  If RRDcollect is not compiled
with librrd, then it will fall back to pipe-mode.

.SS Help and information
.IP "\fB\-V\fR" 4
.PD 0
.IP "\fB\-\-version\fR" 4
.PD
Display RRDcollect's version, compile-time options and license.

.IP "\fB\-h\fR" 4
.PD 0
.IP "\fB\-\-help\fR" 4
.PD
Show summary of options.

.IP "\fB\-\-usage\fR"
.PD
Show short usage information.

.SH FILES
.B !rrdcollect_conf!

.SH "SEE ALSO"
.IR rrdcollect.conf (5),
.IR rrdtool (1),
.IR pcre (3)

.SH BUGS
Hopefully not many...

.SH AUTHOR
.nf
Dawid Kuroczko <qnex@knm.org.pl>
Artur R. Czechowski <arturcz@hell.pl>
.fi
.\" vim:filetype=nroff