Man page of Pod::Text::Overstrike
Section: Perl Programmers Reference Guide (3perl)
Return to Main Contents
Pod::Text::Overstrike - Convert POD data to formatted overstrike text
my $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);
# Read POD from STDIN and write to STDOUT.
# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights
output text using overstrike sequences, in a manner similar to nroff.
Characters in bold text are overstruck (character, backspace, character) and
characters in underlined text are converted to overstruck underscores
(underscore, backspace, character). This format was originally designed for
hardcopy terminals and/or lineprinters, yet is readable on softcopy (CRT)
Overstruck text is best viewed by page-at-a-time programs that take
advantage of the terminal's stand-out and underline capabilities, such
as the less program on Unix.
Apart from the overstrike, it in all ways functions like Pod::Text. See
Pod::Text for details and available options.
Currently, the outermost formatting instruction wins, so for example
underlined text inside a region of bold text is displayed as simply bold.
There may be some better approach possible.
The current version of this module is always available from its web site at
<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
Perl core distribution as of 5.6.0.
Joe Smith <[email protected]>, using the framework created by Russ Allbery
COPYRIGHT AND LICENSE
Copyright 2000 by Joe Smith <[email protected]>.
Copyright 2001, 2004 by Russ Allbery <[email protected]>.
This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.
- SEE ALSO
- COPYRIGHT AND LICENSE
This document was created by
using the manual pages.
Time: 04:14:18 GMT, September 24, 2010