MAN page from Old RedHat 5.X perl-5.004-4.i386.rpm

Pod::Text

Section: Perl Programmers Reference Guide (3)
Updated: perl 5.004, patch 04
Index

NAME

Pod::Text - convert POD data to formatted ASCII text

SYNOPSIS

        use Pod::Text;

        pod2text("perlfunc.pod");

Also:

        pod2text [B<-a>] [B<->I<width>] < input.pod

DESCRIPTION

Pod::Text is a module that can convert documentation in the POD format (suchas can be found throughout the Perl distribution) into formatted ASCII.Termcap is optionally supported for boldface/underline, and can enabled via$Pod::Text::termcap=1. If termcap has not been enabled, then backspaceswill be used to simulate bold and underlined text.

A separate pod2text program is included that is primarily a wrapper forPod::Text.

The single function pod2text() can take the optional options -afor an alternative output format, then a -width option with themax terminal width, followed by one or two arguments. The firstshould be the name of a file to read the pod from, or ``<&STDIN'' to read fromSTDIN. A second argument, if provided, should be a filehandle glob whereoutput should be sent.

AUTHOR

Tom Christiansen <tchristAATTmox.perl.com>

TODO

Cleanup work. The input and output locations need to be more flexible,termcap shouldn't be a global variable, and the terminal speed needs tobe properly calculated.

This document was created byman2html,using the manual pages.