Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Perldoc::ToText.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::ToText 3pm"
61 .TH Pod::Perldoc::ToText 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::ToText \- let Perldoc render Pod as plaintext
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& perldoc \-o text 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 text \-w indent:5 Some::Modulename
85 .Ve
86 .SH CAVEAT
87 .IX Header "CAVEAT"
88 This module may change to use a different text formatter class in the
89 future, and this may change what options are supported.
90 .SH "SEE ALSO"
91 .IX Header "SEE ALSO"
92 Pod::Text, Pod::Perldoc
93 .SH "COPYRIGHT AND DISCLAIMERS"
94 .IX Header "COPYRIGHT AND DISCLAIMERS"
95 Copyright (c) 2002 Sean M. Burke. All rights reserved.
96 .PP
97 This library is free software; you can redistribute it and/or modify it
98 under the same terms as Perl itself.
99 .PP
100 This program is distributed in the hope that it will be useful, but
101 without any warranty; without even the implied warranty of
102 merchantability or fitness for a particular purpose.
103 .SH AUTHOR
104 .IX Header "AUTHOR"
105 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
106 .PP
107 Past contributions from:
108 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
109 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
110 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR