Pod::Text::Overstrike(3p) Perl Programmers Reference Guide #

Pod::Text::Overstrike(3p) Perl Programmers Reference Guide

NNAAMMEE #

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

SSYYNNOOPPSSIISS #

     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');

DDEESSCCRRIIPPTTIIOONN #

 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 ssttaanndd--oouutt and _u_n_d_e_r_l_i_n_e 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.

BBUUGGSS #

 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.

AAUUTTHHOORR #

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

CCOOPPYYRRIIGGHHTT AANNDD LLIICCEENNSSEE #

 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.

SSEEEE AALLSSOO #

 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.

perl v5.36.3 2021-03-02 Pod::Text::Overstrike(3p)