MAN page from PLD perl-modules-5.6.1-71.i386.rpm

Pod::Text::Overstrike

Section: Perl Programmers Reference Guide (3pm)
Updated: perl v5.6.1
Index

NAME

Pod::Text::Overstrike - Convert POD data to formatted overstrike text

SYNOPSIS

    use Pod::Text::Overstrike;    my $parser = Pod::Text::Overstrike->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');

DESCRIPTION

Pod::Text::Overstrike is a simple subclass of Pod::Text that highlightsoutput text using overstrike sequences, in a manner similar to nroff.Characters in bold text are overstruck (character, backspace, character) andcharacters in underlined text are converted to overstruck underscores(underscore, backspace, character). This format was originally designed forhardcopy terminals and/or lineprinters, yet is readable on softcopy (CRT)terminals.

Overstruck text is best viewed by page-at-a-time programs that takeadvantage of the terminal's stand-out and underline capabilities, suchas the less program on Unix.

Apart from the overstrike, it in all ways functions like Pod::Text. Seethe Pod::Text manpage for details and available options.

BUGS

Currently, the outermost formatting instruction wins, so for exampleunderlined text inside a region of bold text is displayed as simply bold.There may be some better approach possible.

AUTHOR

Joe Smith <Joe.SmithAATTinwap.com>, using the framework created by RussAllbery <rraAATTstanford.edu>.

This document was created byman2html,using the manual pages.