Steven Haryanto > Progress-Any-Output-TermProgressBarColor > Progress::Any::Output::TermProgressBarColor

Download:
Progress-Any-Output-TermProgressBarColor-0.10.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.10   Source  

NAME ^

Progress::Any::Output::TermProgressBarColor - Output progress to terminal as color bar

VERSION ^

This document describes version 0.10 of Progress::Any::Output::TermProgressBarColor (from Perl distribution Progress-Any-Output-TermProgressBarColor), released on 2014-07-04.

SYNOPSIS ^

 use Progress::Any::Output;
 Progress::Any::Output->set('TermProgressBarColor', width=>50);

DESCRIPTION ^

THIS IS AN EARLY RELEASE, SOME THINGS ARE NOT YET IMPLEMENTED E.G. TEMPLATE, STYLES, COLOR THEMES.

This output displays progress indicators as colored progress bar on terminal. It produces output similar to that produced by Term::ProgressBar, except that it uses the Progress::Any framework and has additional features:

XXX option to cleanup when complete or not (like in Term::ProgressBar) and should default to 1.

METHODS ^

new(%args) => OBJ

Instantiate. Usually called through Progress::Any::Output->set("TermProgressBarColor", %args).

Known arguments:

ENVIRONMENT ^

COLOR => BOOL

Can be used to force or disable color.

COLOR_DEPTH => INT

Can be used to override color depth detection. See Color::ANSI::Util.

COLUMNS => INT

Can be used to override terminal width detection.

TODO ^

Background updating (through threads or forked process), so progress can still be updated even though the main process is waiting on I/O or external process. But we need to think of a good way to synchronize output.

Animations, like rotating line (- / | \ -) or pulsating (. o O o .). Also animation by varying colors.

Detect connection speed and degrade to lower-frequency updating if connection is slow.

Styles. Preset formats as well as some behaviors like animation.

Detection of column change. On each update(), retrieve terminal width again.

SEE ALSO ^

Progress::Any

Term::ProgressBar

Ruby library: ruby-progressbar, https://github.com/jfelchner/ruby-progressbar

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Progress-Any-Output-TermProgressBarColor.

SOURCE ^

Source repository is at https://github.com/sharyanto/perl-Progress-Any-Output-TermProgressBarColor.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Progress-Any-Output-TermProgressBarColor

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR ^

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Steven Haryanto.

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

syntax highlighting: