Masanori Hara
and 1 contributors

NAME

PerlIO::via::ANSIColor - PerlIO layer for Term::ANSIColor

VERSION

This document describes PerlIO::via::ANSIColor version 0.0.3

SYNOPSIS

    use PerlIO::via::ANSIColor;
    PerlIO::via::ANSIColor->color('green');

    open my $fh, '<:via(ANSIColor)', 'filein';

DESCRIPTION

This module implements a PerlIO layer that adds color to the text using Term::ANSIColor.

METHODS

color

    PerlIO::via::ANSIColor->color('green');

    use PerlIO::via::ANSIColor color => 'reverse green';

Change or retrieve a color to add. This takes same arguments as Term::ANSIColor::color().

paint

    PerlIO::via::ANSIColor->paint(STDOUT);

    PerlIO::via::ANSIColor->paint( STDOUT, 'underscore yellow' );

This does

    binmode $fh, ':via(ANSIColor)';

If new color is specified, try to change color before binmode.

PUSHED

    PerlIO::via::ANSIColor->PUSHED()

FILL

    PerlIO::via::ANSIColor->FILL()

EXAMPLES

Here are some examples.

Adds reverse green color to STDERR

    use PerlIO::via::ANSIColor color => 'reverse green';
    binmode STDERR, ':via(ANSIColor)';

    warn "this outputs is colored\n";
    use PerlIO::via::ANSIColor color => 'blue';
    open my $fh, '<:via(ANSIColor)', 'filein';
    print while <$fh>;

Multiple filehandles

    use PerlIO::via::ANSIColor;

    PerlIO::via::ANSIColor->color('reverse red');
    open my $redfh, ">&STDOUT" or die $!;
    binmode $redfh, ':via(ANSIColor)';

    PerlIO::via::ANSIColor->color('reverse blue');
    open my $bluefh, ">&STDOUT" or die $!;
    binmode $bluefh, ':via(ANSIColor)';

    print $redfh  "this color is reverse red\n";
    print $bluefh "this color is reverse blue\n";

DEPENDENCIES

This module requires Term::ANSIColor.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-perlio-via-ansicolor@rt.cpan.org, or through the web interface at http://rt.cpan.org.

SEE ALSO

PerlIO::via Term::ANSIColor

AUTHOR

Masanori Hara <massa.hara at gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2007-2011, Masanori Hara <massa.hara at gmail.com>.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.