Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change


by root (Scribe)
on Dec 23, 1999 at 00:52 UTC ( #1236=perlfunc: print w/replies, xml ) Need Help??


See the current Perl documentation for Pod::Text.

Here is our local, out-dated (pre-5.6) version:

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

        use Pod::Text;



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

Pod::Text is a module that can convert documentation in the POD format (such as 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 backspaces will be used to simulate bold and underlined text.

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

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


Tom Christiansen <>


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

Log In?

What's my password?
Create A New User
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (7)
As of 2018-06-25 15:32 GMT
Find Nodes?
    Voting Booth?
    Should cpanminus be part of the standard Perl release?

    Results (127 votes). Check out past polls.