Pod::Perldoc::ToTerm - render Pod with terminal escapes
perldoc -o term Some::Modulename
Perl Programmers Reference Guide Pod::Perldoc::ToTerm(3)
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 Pod::Text:
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.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------+
|Availability | runtime/perl-532 |
+---------------+-----------------------+
|Stability | Pass-through volatile |
+---------------+-----------------------+
SEE ALSO
Pod::Text, Pod::Text::Termcap, Pod::Perldoc
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>"
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.perl.org/.
perl v5.32.0 2020-06-14 Pod::Perldoc::ToTerm(3)