.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Progress::Any::Output 3pm"
.TH Progress::Any::Output 3pm "2022-10-30" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Progress::Any::Output \- Assign output to progress indicators
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.220 of Progress::Any::Output (from Perl distribution Progress-Any), released on 2022\-10\-18.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your application:
.PP
.Vb 2
\& use Progress::Any::Output;
\& Progress::Any::Output\->set(\*(AqTermProgressBarColor\*(Aq);
.Ve
.PP
or:
.PP
.Vb 1
\& use Progress::Any::Output \*(AqTermProgressBarColor\*(Aq;
.Ve
.PP
To give parameters to output:
.PP
.Vb 2
\& use Progress::Any::Output;
\& Progress::Any::Output\->set(\*(AqTermProgressBarColor\*(Aq, width=>50, ...);
.Ve
.PP
or:
.PP
.Vb 1
\& use Progress::Any::Output \*(AqTermProgressBarColor\*(Aq, width=>50, ...;
.Ve
.PP
To assign output to a certain (sub)task:
.PP
.Vb 1
\& use Progress::Any::Output \-task => "main.download", \*(AqTermMessage\*(Aq;
.Ve
.PP
or:
.PP
.Vb 2
\& use Progress::Any::Output;
\& Progress::Any::Output\->set({task=>\*(Aqmain.download\*(Aq}, \*(AqTermMessage\*(Aq);
.Ve
.PP
To add additional output, use \f(CW\*(C`add()\*(C'\fR instead of \f(CW\*(C`set()\*(C'\fR.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
See Progress::Any for overview.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "Progress::Any::Output\->set([ \e%opts ], $output[, @args]) => obj"
.el .SS "Progress::Any::Output\->set([ \e%opts ], \f(CW$output\fP[, \f(CW@args\fP]) => obj"
.IX Subsection "Progress::Any::Output->set([ %opts ], $output[, @args]) => obj"
Set (or replace) output. Will load and instantiate
\&\f(CW\*(C`Progress::Any::Output::$output\*(C'\fR. To only set output for a certain (sub)task,
set \f(CW%opts\fR to \f(CW\*(C`{ task => $task }\*(C'\fR. \f(CW@args\fR will be passed to output
module's constructor.
.PP
Return the instantiated object.
.PP
If \f(CW$output\fR is an object (a reference, really), it will be used as-is.
.ie n .SS "Progress::Any::Output\->add([ \e%opts ], $output[, @args])"
.el .SS "Progress::Any::Output\->add([ \e%opts ], \f(CW$output\fP[, \f(CW@args\fP])"
.IX Subsection "Progress::Any::Output->add([ %opts ], $output[, @args])"
Like \fBset()\fR, but will add output instead of replace existing one(s).
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Progress\-Any>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Progress\-Any>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Progress::Any
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "CONTRIBUTING"
.IX Header "CONTRIBUTING"
To contribute, you can send patches by email/via \s-1RT,\s0 or send pull requests on
GitHub.
.PP
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
.PP
.Vb 1
\& % prove \-l
.Ve
.PP
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.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2022, 2020, 2018, 2015, 2014, 2013, 2012 by perlancar <perlancar@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Progress\-Any>
.PP
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.