table of contents
Progress::Any::Output(3pm) | User Contributed Perl Documentation | Progress::Any::Output(3pm) |
NAME¶
Progress::Any::Output - Assign output to progress indicators
VERSION¶
This document describes version 0.220 of Progress::Any::Output (from Perl distribution Progress-Any), released on 2022-10-18.
SYNOPSIS¶
In your application:
use Progress::Any::Output; Progress::Any::Output->set('TermProgressBarColor');
or:
use Progress::Any::Output 'TermProgressBarColor';
To give parameters to output:
use Progress::Any::Output; Progress::Any::Output->set('TermProgressBarColor', width=>50, ...);
or:
use Progress::Any::Output 'TermProgressBarColor', width=>50, ...;
To assign output to a certain (sub)task:
use Progress::Any::Output -task => "main.download", 'TermMessage';
or:
use Progress::Any::Output; Progress::Any::Output->set({task=>'main.download'}, 'TermMessage');
To add additional output, use "add()" instead of "set()".
DESCRIPTION¶
See Progress::Any for overview.
METHODS¶
Progress::Any::Output->set([ \%opts ], $output[, @args]) => obj¶
Set (or replace) output. Will load and instantiate "Progress::Any::Output::$output". To only set output for a certain (sub)task, set %opts to "{ task => $task }". @args will be passed to output module's constructor.
Return the instantiated object.
If $output is an object (a reference, really), it will be used as-is.
Progress::Any::Output->add([ \%opts ], $output[, @args])¶
Like set(), but will add output instead of replace existing one(s).
HOMEPAGE¶
Please visit the project's homepage at <https://metacpan.org/release/Progress-Any>.
SOURCE¶
Source repository is at <https://github.com/perlancar/perl-Progress-Any>.
SEE ALSO¶
Progress::Any
AUTHOR¶
perlancar <perlancar@cpan.org>
CONTRIBUTING¶
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2022, 2020, 2018, 2015, 2014, 2013, 2012 by perlancar <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.
BUGS¶
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Progress-Any>
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.
2022-10-30 | perl v5.36.0 |