NAME

Term::Pulse - show pulsed progress bar in terminal

VERSION

Version 0.04

SYNOPSIS

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

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.

AUTHOR

Yen-Liang Chen, <alec at cpan.com>

BUGS

Please report any bugs or feature requests to bug-term-pulse at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Term-Pulse. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Term::Pulse

You can also look for information at:

• RT: CPAN's request tracker

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Term-Pulse

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Term-Pulse

• CPAN Ratings

  http://cpanratings.perl.org/d/Term-Pulse

• Search CPAN

  http://search.cpan.org/dist/Term-Pulse

COPYRIGHT & LICENSE

Copyright 2008 Alec Chen, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.