View on
MetaCPAN
search.cpan.org is shutting down
For details read Perl NOC. After June 25th this page will redirect to MetaCPAN.org
perlancar > Progress-Any-Output-TermProgressBarColor-0.245 > Progress::Any::Output::TermProgressBarColor

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

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.245   Source  

NAME ^

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

VERSION ^

This document describes version 0.245 of Progress::Any::Output::TermProgressBarColor (from Perl distribution Progress-Any-Output-TermProgressBarColor), released on 2018-03-27.

SYNOPSIS ^

 use Progress::Any::Output;

 # use default options
 Progress::Any::Output->set('TermProgressBarColor');

 # set options
 Progress::Any::Output->set('TermProgressBarColor',
                            width=>50, fh=>\*STDERR, show_delay=>5);

DESCRIPTION ^

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

Sample screenshots:

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:

keep_delay_showing()

Can be called to reset the timer that counts down to show progress bar when show_delay is defined. For example, if show_delay is 5 seconds and two seconds have passed, it should've been 3 seconds before progress bar is shown in the next update(). However, if you call this method, it will be 5 seconds again before showing.

FAQ ^

How to update progress bar output more often?

Set freq to e.g. -0.1 or -0.05. The default freq, when unset, is -0.5 which means to update output at most once every 0.5 second.

ENVIRONMENT ^

COLOR

Bool. Can be used to force or disable color. See Color::ANSI::Util.

COLOR_DEPTH

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

COLUMNS

Integer. Can be used to override terminal width detection.

PROGRESS_TERM_BAR

Bool. Forces disabling or enabling progress output (just for this output).

In the absence of PROGRESS_TERM_MESSAGE and PROGRESS, will default to 1 if filehandle is detected as interactive (using -t).

PROGRESS

Bool. Forces disabling or enabling progress output (for all outputs).

HOMEPAGE ^

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

SOURCE ^

Source repository is at https://github.com/perlancar/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.

SEE ALSO ^

Progress::Any

Term::ProgressBar

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

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2018, 2017, 2016, 2015, 2014, 2013 by perlancar@cpan.org.

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: