/ 
Siebel-Srvrmgr-0.16
River stage zero No dependents
/ Siebel::Srvrmgr::Exporter::TermPulse

NAME

Siebel::Srvrmgr::Exporter::TermPulse - show pulsed progress bar in terminal

SYNOPSIS

use Siebel::Srvrmgr::Exporter::TermPulse;
pulse_start( name => 'Checking', rotate => 0, time => 1 ); # start the pulse
sleep 3;
pulse_stop()                                               # stop it

DESCRIPTION

This module was shamelessly copied from Term::Pulse. Sorry, couldn't get my bug/patch approved. :-)

EXPORT

The following functions are exported by default.

  • pulse_start

  • pulse_stop

FUNCTIONS

pulse_start()

Use this functions to start the pulse. Accept the following arguments:

name

A simple message displayed before the pulse. The default value is 'Working'.

rotate

Boolean. Rotate the pulse if set to 1. Turn off by default.

time

Boolean. Display the elapsed time if set to 1. Turn off by default.

size

Set the pulse size. The default value is 16.

pulse_stop()

Stop the pulse and return elapsed time.

KNOWN PROBLEMS

Not thread safe.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org<>

Term::Pulse was originally created by Yen-Liang Chen, <alec at cpan.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org<>

This file is part of Siebel Monitoring Tools.

Siebel Monitoring Tools is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Siebel Monitoring Tools 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 for more details.

You should have received a copy of the GNU General Public License along with Siebel Monitoring Tools. If not, see <http://www.gnu.org/licenses/>.