Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod::text::overstrike(3pm) [osx man page]

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

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. SEE ALSO
Pod::Text, Pod::Simple The current version of this module is always available from its web site at <http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0. AUTHOR
Joe Smith <Joe.Smith@inwap.com>, using the framework created by Russ Allbery <rra@stanford.edu>. COPYRIGHT AND LICENSE
Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>. Copyright 2001, 2004, 2008 by Russ Allbery <rra@stanford.edu>. This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. perl v5.16.2 2012-08-26 Pod::Text::Overstrike(3pm)

Check Out this Related Man Page

Pod::Text::Color(3pm)					 Perl Programmers Reference Guide				     Pod::Text::Color(3pm)

NAME
Pod::Text::Color - Convert POD data to formatted color ASCII text SYNOPSIS
use Pod::Text::Color; my $parser = Pod::Text::Color->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::Color is a simple subclass of Pod::Text that highlights output text using ANSI color escape sequences. Apart from the color, it in all ways functions like Pod::Text. See Pod::Text for details and available options. Term::ANSIColor is used to get colors and therefore must be installed to use this module. BUGS
This is just a basic proof of concept. It should be seriously expanded to support configurable coloration via options passed to the constructor, and pod2text should be taught about those. SEE ALSO
Pod::Text, Pod::Simple The current version of this module is always available from its web site at <http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0. AUTHOR
Russ Allbery <rra@stanford.edu>. COPYRIGHT AND LICENSE
Copyright 1999, 2001, 2004, 2006, 2008, 2009 Russ Allbery <rra@stanford.edu>. This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. perl v5.16.2 2012-08-26 Pod::Text::Color(3pm)
Man Page