Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Perldoc::ToTerm.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Perldoc::ToTerm 3pm"
61 .TH Pod::Perldoc::ToTerm 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Perldoc::ToTerm \- render Pod with terminal escapes
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& perldoc \-o term Some::Modulename
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 This is a "plug\-in" class that allows Perldoc to use
76 Pod::Text as a formatter class.
77 .PP
78 It supports the following options, which are explained in
79 Pod::Text: alt, indent, loose, quotes, sentence, width
80 .PP
81 For example:
82 .PP
83 .Vb 1
84 \& perldoc \-o term \-w indent:5 Some::Modulename
85 .Ve
86 .SH "PAGER FORMATTING"
87 .IX Header "PAGER FORMATTING"
88 Depending on the platform, and because this class emits terminal escapes it
89 will attempt to set the \f(CW\*(C`\-R\*(C'\fR flag on your pager by injecting the flag into
90 your environment variable for \f(CW\*(C`less\*(C'\fR or \f(CW\*(C`more\*(C'\fR.
91 .PP
92 On Windows and DOS, this class will not modify any environment variables.
93 .SH CAVEAT
94 .IX Header "CAVEAT"
95 This module may change to use a different text formatter class in the
96 future, and this may change what options are supported.
97 .SH "SEE ALSO"
98 .IX Header "SEE ALSO"
99 Pod::Text, Pod::Text::Termcap, Pod::Perldoc
100 .SH "COPYRIGHT AND DISCLAIMERS"
101 .IX Header "COPYRIGHT AND DISCLAIMERS"
102 Copyright (c) 2017 Mark Allen.
103 .PP
104 This program is free software; you can redistribute it and/or modify it
105 under the terms of either: the GNU General Public License as published
106 by the Free Software Foundation; or the Artistic License.
107 .PP
108 See http://dev.perl.org/licenses/ for more information.
109 .SH AUTHOR
110 .IX Header "AUTHOR"
111 Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR