# $Id: //eai/perl5/Rstat-Client/2.2/src/distro/README#2 $
This is the README file for Rstat::Client
INTRODUCTION
Rstat::Client is a Perll library that provides client access to
rstatd(8) statistics for UNIX servers. Connections to rstatd
servers are Perl objects, so you may collect statistical data from
multiple servers from within one Perl script.
Using Rstat::Client is as simple as:
use Rstat::Client;
$clnt = Rstat::Client->new('some.host');
$stats = $clnt->fetch();
printf 'CPU Load @some.host: %.2f %.2f %.2f\n', @{$stats->{'avenrun'}};
PREREQUISITES
Starting with version 2.0, Rstat::Client is implemented in pure
Perl and has no specific prerequisites.
INSTALLATION
Unpack the distribution archive and chdir into Rstat-Client-xxx.
Then type the following commands:
perl Makefile.PL
make
make test
make install
Make sure rstatd is running on localhost or 'make test' will fail.
HISTORY
Rstat::Client was originally written by Axel Schwenke
<axel.schwenke@gmx.net>, and versions 1.2 and earlier bear the
following copyright:
Copyright (c) 2002 Axel Schwenke. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
In May 2005, Ron Isaacson <ron.isaacson@morganstanley.com> took
ownership of Rstat::Client. Version 2.0, the first pure-Perl
implementation, was never released outside of Morgan Stanley;
version 2.2 was the first pure-Perl version released on CPAN.
AUTHOR
Ron Isaacson <ron.isaacson@morganstanley.com>
COPYRIGHT
Copyright (c) 2008, Morgan Stanley & Co. Incorporated
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License,
version 2, as published by the Free Software Foundation.
Versions of this program prior to version 2.0 were released under
the same terms as Perl itself, not the GNU General Public License,
version 2.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License, version 2 for more details.
A copy of the GNU General Public License was distributed with this
program in a file called LICENSE. For additional copies, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth
Floor, Boston, MA 02110-1301 USA.
THE FOLLOWING DISCLAIMER APPLIES TO ALL SOFTWARE CODE AND OTHER
MATERIALS CONTRIBUTED IN CONNECTION WITH THIS SOFTWARE:
THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY
WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE
MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR
ANOTHER EQUIVALENT DISCLAIMER AS WELL AS ANY OTHER LICENSE TERMS
THAT MAY APPLY.