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

COMPATIBILITY

40       Pod::Text::Overstrike 1.01 (based on Pod::Parser) was the first version
41       of this module included with Perl, in Perl 5.6.1.
42
43       The current API based on Pod::Simple was added in Pod::Text::Overstrike
44       2.00, included in Perl 5.9.3.
45
46       Several problems with wrapping and line length were fixed as recently
47       as Pod::Text::Overstrike 2.04, included in Perl 5.11.5.
48
49       This module inherits its API and most behavior from Pod::Text, so the
50       details in "COMPATIBILITY" in Pod::Text also apply.  Pod::Text and
51       Pod::Text::Overstrike have had the same module version since 4.00,
52       included in Perl 5.23.7.  (They unfortunately diverge in confusing ways
53       prior to that.)
54

AUTHOR

56       Originally written by Joe Smith <Joe.Smith@inwap.com>, using the
57       framework created by Russ Allbery <rra@cpan.org>.  Subsequently updated
58       by Russ Allbery.
59

61       Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>
62
63       Copyright 2001, 2004, 2008, 2014, 2018-2019, 2022 by Russ Allbery
64       <rra@cpan.org>
65
66       This program is free software; you may redistribute it and/or modify it
67       under the same terms as Perl itself.
68

SEE ALSO

70       Pod::Text, Pod::Simple
71
72       The current version of this module is always available from its web
73       site at <https://www.eyrie.org/~eagle/software/podlators/>.  It is also
74       part of the Perl core distribution as of 5.6.0.
75
76
77
78perl v5.36.0                      2023-01-20          Pod::Text::Overstrike(3)
Impressum