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. $parser->parse_from_filehandle; # Read POD from file.pod and write to file.txt. $parser->parse_from_file ('file.pod', 'file.txt');
Perl Programmers Reference Guide Pod::Text::Overstrike(3) 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 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 hard-copy terminals and/or line printers, yet is readable on soft-copy (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. BUGS 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. AUTHOR Originally written by Joe Smith <Joe.Smith@inwap.com>, using the framework created by Russ Allbery <rra@cpan.org>. Subsequently updated by Russ Allbery. COPYRIGHT AND LICENSE Copyright 2000 by Joe Smith <Joe.Smith@inwap.com> Copyright 2001, 2004, 2008, 2014, 2018-2019 by Russ Allbery <rra@cpan.org> This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. ATTRIBUTES See attributes(7) for descriptions of the following attributes: +---------------+-----------------------+ |ATTRIBUTE TYPE | ATTRIBUTE VALUE | +---------------+-----------------------+ |Availability | runtime/perl-532 | +---------------+-----------------------+ |Stability | Pass-through volatile | +---------------+-----------------------+ SEE ALSO Pod::Text, Pod::Simple The current version of this module is always available from its web site at <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0. NOTES Source code for open source software components in Oracle Solaris can be found at https://www.oracle.com/downloads/opensource/solaris-source- code-downloads.html. This software was built from source available at https://github.com/oracle/solaris-userland. The original community source was downloaded from http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz. Further information about this software can be found on the open source community website at https://www.perl.org/. perl v5.32.0 2020-06-14 Pod::Text::Overstrike(3)