You are viewing the version of this documentation from Perl 5.6.2. View the latest version



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


use Pod::Text::Overstrike;
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) terminals.

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.


Pod::Text, Pod::Parser


Joe Smith <>, using the framework created by Russ Allbery <>.