File: index.pod

package info (click to toggle)
remstats 1.00a4-8woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,576 kB
  • ctags: 1,020
  • sloc: perl: 11,706; ansic: 2,776; makefile: 944; sh: 869
file content (55 lines) | stat: -rw-r--r-- 1,631 bytes parent folder | download
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

=cut

TITLE=About Remstats
DESCRIPTION=About Remstats
KEYWORDS=remstats,rrdtool
DOCTOP=index
DOCPREV=topics
DOCNEXT=releasenotes
SECTION=About Remstats

=pod

=head1 About Remstats

Remstats is a system of programs to:

=over 4

=item - gather data from servers and routers,

=item - store and maintain the data for long periods,

=item - produce graphs and web-pages tieing them together, and

=item - monitor the data for anomalous behavious and issue alerts

=back 4

It's built on
L<RRDtool|http://ee-staff.ethz.ch/~oetiker/webtools/rrdtool/>.
There is a L<proto-FAQ|faq>; feel free to contribute.  There's
also a L<to-do list|todo> to give some idea what might be coming.

=head2 Where to get it

The best available version is @@BESTAVAILABLEVERSION@@.  You can get it at 
L<@@SRCURL@@src/remstats-@@BESTAVAILABLEVERSION@@.tar.gz|@@SRCURL@@src/remstats-@@BESTAVAILABLEVERSION@@.tar.gz>.
The current version is @@VERSION@@.  (This version may not be
available yet, as I will push out new documentation before the
new release, to make additions/corrections available as soon 
as possible.)  You can get other versions of remstats from the 
L<source archive|@@SRCURL@@src>.  Since almost all of it is 
written in L<perl|http://www.perl.org/> scripts, there is no binary version.  

=head2 How to get started

First, you should make sure that you have all the L<requirements|required>.
Then read the L<installation docs|install>.  Then read the 
L<server installation docs|install-servers>.  

Then check out L<run-remstats> which runs almost everything else and documents
how all the pieces work together.

L<Thank-you|thanks>.