unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (OpenBSD-3.6)
Page:
Section:
Apropos / Subsearch:
optional field



Pod::Text::OverstPerl(Programmers ReferePod::Text::Overstrike(3p)


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 charac-
       ters in underlined text are converted to overstruck under-
       scores (underscore, backspace, character).  This format
       was originally designed for hardcopy terminals and/or
       lineprinters, yet is readable on softcopy (CRT) terminals.

       Overstruck text is best viewed by page-at-a-time programs
       that take advantage of the terminal's stand-out and under-
       line 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.

SEE ALSO
       Pod::Text, Pod::Parser

       The current version of this module is always available
       from its web site at <http://www.eyrie.org/~eagle/soft-
       ware/podlators/>.  It is also part of the Perl core dis-
       tribution as of 5.6.0.

AUTHOR
       Joe Smith <Joe.SmithATinwap.com>, using the framework cre-
       ated by Russ Allbery <rraATstanford.edu>.

COPYRIGHT AND LICENSE
       Copyright 2000 by Joe Smith <Joe.SmithATinwap.com>.  Copy-
       right 2001 by Russ Allbery <rraATstanford.edu>.




perl v5.8.5                 2002-11-06                          1





Pod::Text::OverstPerl(Programmers ReferePod::Text::Overstrike(3p)


       This program is free software; you may redistribute it
       and/or modify it under the same terms as Perl itself.























































perl v5.8.5                 2002-11-06                          2