Unix/Linux Go Back    

RedHat 9 (Linux i386) - man page for pod::text::overstrike (redhat section 3pm)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

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

       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.

	   # Read POD from file.pod and write to file.txt.
	   $parser->parse_from_file ('file.pod', 'file.txt');

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

       Overstruck text is best viewed by page-at-a-time programs that take advantage of the ter-
       minal'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.

       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.

       Pod::Text, Pod::Parser

       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 dis-
       tribution as of 5.6.0.

       Joe Smith <Joe.Smith@inwap.com>, using the framework created by Russ Allbery <rra@stan-

       Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>.  Copyright 2001 by Russ Allbery

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

perl v5.8.0				    2002-06-01		       Pod::Text::Overstrike(3pm)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 08:11 AM.