Boris Zentner > Pod-Simple-Text-Termcap > Pod::Simple::Text::Termcap

Download:
Pod-Simple-Text-Termcap-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Pod::Simple::Text::Termcap - Convert POD data to ASCII text with format escapes

VERSION ^

Version 0.01

SYNOPSIS ^

Convert POD data to ASCII text with format escapes

  ( my $pod_text = <<'__POD__' ) =~ s/^[ \t]+//mg;
    =head1 Some pod

    F<foo> bla bla B<bar>
    Some more text

    =cut
  __POD__

  #
  use Pod::Simple::Text::Termcap;
  my $parser = Pod::Simple::Text::Termcap->new;
  $parser->parse_string_document( $pod_text);
  $parser->output_string( \my $out );
  print($out);


  # use it as a filter
  use Pod::Simple::Text::Termcap;
  Pod::Simple::Text::Termcap->filter( \$pod_text );

DESCRIPTION ^

Pod::Simple::Text::Termcap is a subclass of Pod::Simple::Text. This module is just a drop in replacement for Pod::Simple::Text. Pod::Simple::Text::Termcap prints headlines and B<> tags bold. I<> and F<> tags are underlined.

Thats all. Pretty close to what Pod::Text::Termcap do for Pod::Text.

NOTES ^

This module uses Term::Cap to retrieve the formatting escape sequences for the current terminal, and falls back on the ECMA-48 (the same in this regard as ANSI X3.64 and ISO 6429, the escape codes also used by DEC VT100 terminals) if the bold, underline, and reset codes aren't set in the termcap information.

SEE ALSO ^

Pod::Simple, Pod::Simple::Text, Pod::Text, Pod::Text::Termcap

EXPORT ^

Nothing

AUTHOR ^

Boris Zentner, <bzm@2bz.de>

BUGS ^

Please report any bugs or feature requests to bug-pod-simple-text-termcap@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Simple-Text-Termcap. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS ^

Parts stolen from Russ Allbery's Pod::Text::Termcap.

COPYRIGHT & LICENSE ^

Copyright 2005 Boris Zentner, All Rights Reserved.

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

syntax highlighting: