Pod::Perldoc::ToTerm(3perl) Perl Programmers Reference Guide Pod::Perldoc::ToTerm(3perl)

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

perldoc -o term Some::Modulename

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

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.

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

Pod::Text, Pod::Text::Termcap, Pod::Perldoc

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.

Mark Allen "<mallen@cpan.org>"

2022-12-12 perl v5.36.0