# Pod::Text::Termcap - perldoc - [phpMan]

## NAME
    [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) - Convert POD data to ASCII text with format escapes

## SYNOPSIS
        use [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown);
        my $parser = [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown)->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::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) is a simple subclass of [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown) 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](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown). See [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown) for details and available options.

    This module uses [Term::Cap](https://www.chedong.com/phpMan.php/perldoc/Term%3A%3ACap/markdown) to find the correct terminal settings. See the documentation of that
    module for how it finds terminal database information and how to override that behavior if
    necessary. If unable to find control strings for bold and underscore formatting, that formatting
    is skipped, resulting in the same output as [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown).

## COMPATIBILITY
    [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) 0.04 (based on [Pod::Parser](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AParser/markdown)) was the first version of this module included
    with Perl, in Perl 5.6.0.

    The current API based on [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown) was added in [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) 2.00. [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown)
    2.01 was included in Perl 5.9.3, the first version of Perl to incorporate those changes.

    Several problems with wrapping and line length were fixed as recently as [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown)
    4.11, included in Perl 5.29.1.

    [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) 4.13 stopped setting the TERMPATH environment variable during module load. It
    also stopped falling back on VT100 escape sequences if [Term::Cap](https://www.chedong.com/phpMan.php/perldoc/Term%3A%3ACap/markdown) was not able to find usable
    escape sequences, instead producing unformatted output for better results on dumb terminals. The
    next version to be incorporated into Perl, 4.14, was included in Perl 5.31.8.

    This module inherits its API and most behavior from [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown), so the details in "COMPATIBILITY"
    in [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown) also apply. [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown) and [Pod::Text::Termcap](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText%3A%3ATermcap/markdown) have had the same module version since
    4.00, included in Perl 5.23.7. (They unfortunately diverge in confusing ways prior to that.)

## AUTHOR
    Russ Allbery <<rra@cpan.org>>

## COPYRIGHT AND LICENSE
    Copyright 1999, 2001-2002, 2004, 2006, 2008-2009, 2014-2015, 2018-2019, 2022 Russ Allbery
    <<rra@cpan.org>>

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

## SEE ALSO
    [Pod::Text](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AText/markdown), [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown), [Term::Cap](https://www.chedong.com/phpMan.php/perldoc/Term%3A%3ACap/markdown)

    The current version of this module is always available from its web site at
    <<https://www.eyrie.org/~eagle/software/podlators/>>. It is also part of the Perl core
    distribution as of 5.6.0.