1Pod::Perldoc::ToTerm(3)User Contributed Perl DocumentatioPnod::Perldoc::ToTerm(3)
2
3
4

NAME

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

SYNOPSIS

9         perldoc -o term Some::Modulename
10

DESCRIPTION

12       This is a "plug-in" class that allows Perldoc to use Pod::Text as a
13       formatter class.
14
15       It supports the following options, which are explained in Pod::Text:
16       alt, indent, loose, quotes, sentence, width
17
18       For example:
19
20         perldoc -o term -w indent:5 Some::Modulename
21

PAGER FORMATTING

23       Depending on the platform, and because this class emits terminal
24       escapes it will attempt to set the "-R" flag on your pager by injecting
25       the flag into your environment variable for "less" or "more".
26
27       On Windows and DOS, this class will not modify any environment
28       variables.
29

CAVEAT

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

SEE ALSO

35       Pod::Text, Pod::Text::Termcap, Pod::Perldoc
36

38       Copyright (c) 2017 Mark Allen.
39
40       This program is free software; you can redistribute it and/or modify it
41       under the terms of either: the GNU General Public License as published
42       by the Free Software Foundation; or the Artistic License.
43
44       See http://dev.perl.org/licenses/ for more information.
45

AUTHOR

47       Mark Allen "<mallen@cpan.org>"
48
49
50
51perl v5.30.1                      2020-01-30           Pod::Perldoc::ToTerm(3)
Impressum