build system: Rename `rrdd' to `rrdcached'.
[rrdtool.git] / doc / rrdcached.pod
1 =pod
2
3 =head1 NAME
4
5 rrdcached - Data caching daemon for rrdtool
6
7 =head1 SYNOPSIS
8
9 B<rrdcached> [B<-l> I<address>] [B<-w> I<timeout>] [B<-f> I<timeout>]
10
11 =head1 DESCRIPTION
12
13 B<rrdcached> is a daemon that receives updates to existing RRD files,
14 accumulates them and, if enough have been received or a defined time has
15 passed, writes the updates to the RRD file. A I<flush> command may be used to
16 force writing of values to disk, so that graphing facilities and similar can
17 work with up-to-date data.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-l> I<address>
24
25 Tells the daemon to bind to I<address> and accept incoming connections on that
26 socket. If I<address> begins with C<unix:>, everthing following that prefix is
27 interpreted as the path to a UNIX domain socket. Otherwise the address or node
28 name are resolved using L<getaddrinfo(3)>.
29
30 =item B<-w> I<timeout>
31
32 Data is written to disk every I<timeout> seconds.
33
34 =item B<-f> I<timeout>
35
36 Every I<timeout> seconds the entire cache is searched for old values which are
37 written to disk. This only concerns files to which updates have stopped, so
38 setting this to a high value, such as 3600 seconds, is acceptable in most
39 cases.
40
41 =back
42
43 =head1 BUGS
44
45 =over 4
46
47 =item
48
49 Base directory is currently hard coded. The daemon will chdir to C</tmp/>.
50
51 =back
52
53 =head1 SEE ALSO
54
55 L<rrdtool(1)>, L<rrdgraph(1)>
56
57 =head1 AUHOR
58
59 B<rrdcached> and this manual page have been written by Florian Forster
60 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.