Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Pod::Perldoc::ToTerm

Name Pod::Perldoc::ToTerm
Version 3.28
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Pod/Perldoc/ToTerm.pm
Is Core No
Search CPAN for this module Pod::Perldoc::ToTerm
Documentation Pod::Perldoc::ToTerm
Module Details Pod::Perldoc::ToTerm

NAME

Pod::Perldoc::ToTerm - render Pod with terminal escapes


SYNOPSIS

  perldoc -o term Some::Modulename


DESCRIPTION

This is a ``plug-in'' class that allows Perldoc to use Pod::Text as a formatter class.

It supports the following options, which are explained in the Pod::Text manpage: alt, indent, loose, quotes, sentence, width

For example:

  perldoc -o term -w indent:5 Some::Modulename


PAGER FORMATTING

Depending on the platform, and because this class emits terminal escapes it will attempt to set the -R flag on your pager by injecting the flag into your environment variable for less or more.

On Windows and DOS, this class will not modify any environment variables.


CAVEAT

This module may change to use a different text formatter class in the future, and this may change what options are supported.


SEE ALSO

the Pod::Text manpage, the Pod::Text::Termcap manpage, the Pod::Perldoc manpage


COPYRIGHT AND DISCLAIMERS

Copyright (c) 2017 Mark Allen.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.


AUTHOR

Mark Allen <mallen@cpan.org>

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024