1Pod::Text::Overstrike(3U)ser Contributed Perl DocumentatiPoond::Text::Overstrike(3)
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,
22       character) and characters in underlined text are converted to
23       overstruck underscores (underscore, backspace, character).  This format
24       was originally designed for hard-copy terminals and/or line printers,
25       yet is readable on soft-copy (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

AUTHOR

40       Originally written by Joe Smith <Joe.Smith@inwap.com>, using the
41       framework created by Russ Allbery <rra@cpan.org>.  Subsequently updated
42       by Russ Allbery.
43

45       Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>
46
47       Copyright 2001, 2004, 2008, 2014, 2018 by Russ Allbery <rra@cpan.org>
48
49       This program is free software; you may redistribute it and/or modify it
50       under the same terms as Perl itself.
51

SEE ALSO

53       Pod::Text, Pod::Simple
54
55       The current version of this module is always available from its web
56       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
57       part of the Perl core distribution as of 5.6.0.
58
59
60
61perl v5.26.3                      2018-05-07          Pod::Text::Overstrike(3)
Impressum