manpagez: man pages & more
man Pod::Text::Termcap(3)
Home | html | info | man
Pod::Text::Termcap(3pm)Perl Programmers Reference GuidePod::Text::Termcap(3pm)


       Pod::Text::Termcap - Convert POD data to ASCII text with format escapes


           use Pod::Text::Termcap;
           my $parser = Pod::Text::Termcap->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::Termcap is a simple subclass of Pod::Text that highlights
       output text using the correct termcap escape sequences for the current
       terminal.  Apart from the format codes, it in all ways functions like
       Pod::Text.  See Pod::Text for details and available options.


       This module sets the TERMPATH environment variable globally to:


       if it isn't already set.  (The first entry is omitted if the HOME
       environment variable isn't set.)  This is a (very old) workaround for
       problems finding termcap information on older versions of Solaris, and
       is not good module behavior.  Please do not rely on this behavior; it
       may be dropped in a future release.


       This module uses Term::Cap to retrieve the formatting escape sequences
       for the current terminal, and falls back on the ECMA-48 (the same in
       this regard as ANSI X3.64 and ISO 6429, the escape codes also used by
       DEC VT100 terminals) if the bold, underline, and reset codes aren't set
       in the termcap information.


       Pod::Text(3), Pod::Simple(3), Term::Cap(3)

       The current version of this module is always available from its web
       site at <>.  It is also
       part of the Perl core distribution as of 5.6.0.


       Russ Allbery <>.


       Copyright 1999, 2001, 2002, 2004, 2006, 2008, 2009, 2014, 2015 Russ
       Allbery <>

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

perl v5.24.0                      2016-04-06           Pod::Text::Termcap(3pm)

perl 5.24 - Generated Mon Nov 21 16:52:34 CST 2016
© 2000-2018
Individual documents may contain additional copyright information.