.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Perldoc::ToTerm 3perl"
.TH Pod::Perldoc::ToTerm 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Perldoc::ToTerm \- render Pod with terminal escapes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  perldoc \-o term Some::Modulename
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a \*(L"plug-in\*(R" class that allows Perldoc to use
Pod::Text as a formatter class.
.PP
It supports the following options, which are explained in
Pod::Text: alt, indent, loose, quotes, sentence, width
.PP
For example:
.PP
.Vb 1
\&  perldoc \-o term \-w indent:5 Some::Modulename
.Ve
.SH "PAGER FORMATTING"
.IX Header "PAGER FORMATTING"
Depending on the platform, and because this class emits terminal escapes it
will attempt to set the \f(CW\*(C`\-R\*(C'\fR flag on your pager by injecting the flag into
your environment variable for \f(CW\*(C`less\*(C'\fR or \f(CW\*(C`more\*(C'\fR.
.PP
On Windows and \s-1DOS,\s0 this class will not modify any environment variables.
.SH "CAVEAT"
.IX Header "CAVEAT"
This module may change to use a different text formatter class in the
future, and this may change what options are supported.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Text, Pod::Text::Termcap, Pod::Perldoc
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2017 Mark Allen.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mark Allen \f(CW\*(C`<mallen@cpan.org>\*(C'\fR