17 Aug 2010 22:53:36 UTC
- Distribution: Pod-Text-Ansi
- Module version: 0.05
- Source (raw)
- Browse (raw)
- How to Contribute
- Repository (git clone)
- Testers (1270 / 0 / 0)
- KwaliteeBus factor: 0
- 18.69% Coverage
- License: artistic_2
- Perl: v5.6.0
- Activity24 month
- Download (7.49KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version
Pod::Text::Ansi - Convert POD to ANSI-colored text
use Pod::Text::Ansi; my $parser = Pod::Text::Ansi->new (sentence => 0, width => 78); # Read POD from STDIN and write to STDOUT. $parser->parse_from_filehandle; # Read POD from file.pod and write to file.txt. $parser->parse_from_file ('file.pod', 'file.txt');
Pod::Text::Ansi is a simple subclass of Pod::Text that highlights output text using ANSI color escape sequences. Apart from the color, it in all ways functions like Pod::Text. See Pod::Text for details and available options.
Hinrik Örn Sigurðsson, email@example.com
It currently doesn't respect some forms of nesting.
I<'italic', C<'italic code'>, 'italic'>.
Contrary to what the three terms above say, they will be rendered as italic only, then code only, then normal, respectively.
Non-overlapping nesting such as the following does work, though:
I< C<italic code> >
The wrapping code isn't perfect.
Some formatting codes that stretch over multiple lines will break. One example would be an
L<>code that's too long to fit on one line.
Copyright 1999, 2001, 2004, 2006 by Russ Allbery firstname.lastname@example.org.
Copyright (c) 2009, Hinrik Örn Sigurðsson email@example.com.
This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
Module Install Instructions
To install Pod::Text::Ansi, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Pod::Text::Ansi
For more information on module installation, please visit the detailed CPAN module installation guide.