1Pod::Text::Overstrike(3pPme)rl Programmers Reference GuiPdoed::Text::Overstrike(3pm)
2
3
4

NAME

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

SYNOPSIS

9           use Pod::Text::Overstrike;
10           my $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);
11
12           # Read POD from STDIN and write to STDOUT.
13           $parser->parse_from_filehandle;
14
15           # Read POD from file.pod and write to file.txt.
16           $parser->parse_from_file ('file.pod', 'file.txt');
17

DESCRIPTION

19       Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights
20       output text using overstrike sequences, in a manner similar to nroff.
21       Characters in bold text are overstruck (character, backspace, charac‐
22       ter) and characters in underlined text are converted to overstruck
23       underscores (underscore, backspace, character).  This format was origi‐
24       nally designed for hardcopy terminals and/or lineprinters, yet is read‐
25       able on softcopy (CRT) terminals.
26
27       Overstruck text is best viewed by page-at-a-time programs that take
28       advantage of the terminal's stand-out and underline capabilities, such
29       as the less program on Unix.
30
31       Apart from the overstrike, it in all ways functions like Pod::Text.
32       See Pod::Text for details and available options.
33

BUGS

35       Currently, the outermost formatting instruction wins, so for example
36       underlined text inside a region of bold text is displayed as simply
37       bold.  There may be some better approach possible.
38

SEE ALSO

40       Pod::Text, Pod::Parser
41
42       The current version of this module is always available from its web
43       site at <http://www.eyrie.org/~eagle/software/podlators/>.  It is also
44       part of the Perl core distribution as of 5.6.0.
45

AUTHOR

47       Joe Smith <Joe.Smith@inwap.com>, using the framework created by Russ
48       Allbery <rra@stanford.edu>.
49

51       Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>.  Copyright 2001 by
52       Russ Allbery <rra@stanford.edu>.
53
54       This program is free software; you may redistribute it and/or modify it
55       under the same terms as Perl itself.
56
57
58
59perl v5.8.8                       2001-09-21        Pod::Text::Overstrike(3pm)
Impressum