NAME

Hardware::UPS::Perl::Utils - utility functions for packages dealing with an UPS

SYNOPSIS

use Hardware::UPS::Perl::Utils qw(
   configure error warning
);

DESCRIPTION

Hardware::UPS::Perl::Utils provides functions for packages dealing with an UPS.

LIST OF FUNCTIONS

configure

Name:

configure - processes arguments

Synopsis:

&configure($actions, \@arguments);

Description:

configure processes arguments @arguments using the action table $actions being an anonymous hash of anonymous subroutines.

Arguments:

$actions

the action table; supplies a set of anonymous subroutines to process the options.

$arguments

anonymous array of arguments.

error

Name:

error - displays internal error messages and dies

Synopsis:

&error($errorMessage);

Description:

error displays the error message $errorMessage with respect to the calling method and dies using Carp::croak().

Arguments:

$errorMessage

string; the error message.

See Also:

"warning"

warning

Name:

warning - displays internal error messages

Synopsis:

&warning($warningMessage);

Description:

warning displays the error message $warningMessage with respect to the calling method using Carp::carp().

Arguments:

$warningMessage

string; the warning message.

See Also:

"error"

SEE ALSO

Carp(3pm), Hardware::UPS::Perl::Connection(3pm), Hardware::UPS::Perl::Connection::Net(3pm), Hardware::UPS::Perl::Connection::Serial(3pm) Hardware::UPS::Perl::Constants(3pm), Hardware::UPS::Perl::Driver(3pm), Hardware::UPS::Perl::Driver::Megatec(3pm), Hardware::UPS::Perl::General(3pm), Hardware::UPS::Perl::Logging(3pm), Hardware::UPS::Perl::PID(3pm),

NOTES

Hardware::UPS::Perl::Utils was inspired by the usv.pl program by Bernd Holzhauer, <www.cc-c.de>. The latest version of this program can be obtained from

http://www.cc-c.de/german/linux/linux_usv.php

Another great resource was the Network UPS Tools site, which can be found at

http://www.networkupstools.org

Hardware::UPS::Perl::Utils was developed using perl 5.8.8 on a SuSE 10.1 Linux distribution.

BUGS

There are plenty of them for sure. Maybe the embedded pod documentation has to be revised a little bit.

Suggestions to improve Hardware::UPS::Perl::Utils are welcome, though due to the lack of time it might take a while to incorporate them.

AUTHOR

Copyright (c) 2007 by Christian Reile, <Christian.Reile@t-online.de>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. For further licensing details, please see the file COPYING in the distribution.