Debian Codegraph @

upstream/opensuse-tumbleweed/man1/pod2text.1

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 "POD2TEXT 1"
61 .TH POD2TEXT 1 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 pod2text \- Convert POD data to formatted ASCII text
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 pod2text [\fB\-aclostu\fR] [\fB\-\-code\fR] [\fB\-e\fR\ \fIencoding\fR]
71 [\fB\-\-errors\fR=\fIstyle\fR] [\fB\-\-guesswork\fR=\fIrule\fR[,\fIrule\fR...]]
72 [\fB\-i\fR\ \fIindent\fR] [\fB\-q\fR\ \fIquotes\fR]
73 [\fB\-\-nourls\fR] [\fB\-\-stderr\fR] [\fB\-w\fR\ \fIwidth\fR] [\fIinput\fR [\fIoutput\fR ...]]
74 .PP
75 pod2text \fB\-h\fR
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBpod2text\fR is a wrapper script around the Pod::Text and its subclasses.
79 It uses them to generate formatted text from POD source. It can optionally
80 use either termcap sequences or ANSI color escape sequences to format the
81 text.
82 .PP
83 \&\fIinput\fR is the file to read for POD source (the POD can be embedded in code).
84 If \fIinput\fR isn\*(Aqt given, it defaults to \f(CW\*(C`STDIN\*(C'\fR. \fIoutput\fR, if given, is the
85 file to which to write the formatted output. If \fIoutput\fR isn\*(Aqt given, the
86 formatted output is written to \f(CW\*(C`STDOUT\*(C'\fR. Several POD files can be processed
87 in the same \fBpod2text\fR invocation (saving module load and compile times) by
88 providing multiple pairs of \fIinput\fR and \fIoutput\fR files on the command line.
89 .PP
90 By default, the output encoding is the same as the encoding of the input file,
91 or UTF\-8 if that encoding is not set (except on EBCDIC systems). See the
92 \&\fB\-e\fR option to explicitly set the output encoding and "Encoding" in Pod::Text
93 for more discussion.
94 .SH OPTIONS
95 .IX Header "OPTIONS"
96 Each option is annotated with the version of podlators in which that option
97 was added with its current meaning.
98 .IP "\fB\-a\fR, \fB\-\-alt\fR" 4
99 .IX Item "-a, --alt"
100 [1.00] Use an alternate output format that, among other things, uses a
101 different heading style and marks \f(CW\*(C`=item\*(C'\fR entries with a colon in the left
102 margin.
103 .IP \fB\-\-code\fR 4
104 .IX Item "--code"
105 [1.11] Include any non\-POD text from the input file in the output as well.
106 Useful for viewing code documented with POD blocks with the POD rendered and
107 the code left intact.
108 .IP "\fB\-c\fR, \fB\-\-color\fR" 4
109 .IX Item "-c, --color"
110 [1.00] Format the output with ANSI color escape sequences. Using this option
111 requires that Term::ANSIColor be installed on your system.
112 .IP "\fB\-e\fR \fIencoding\fR, \fB\-\-encoding\fR=\fIencoding\fR" 4
113 .IX Item "-e encoding, --encoding=encoding"
114 [5.00] Specifies the encoding of the output. \fIencoding\fR must be an encoding
115 recognized by the Encode module (see Encode::Supported). If the output
116 contains characters that cannot be represented in this encoding, that is an
117 error that will be reported as configured by the \f(CW\*(C`errors\*(C'\fR option. If error
118 handling is other than \f(CW\*(C`die\*(C'\fR, the unrepresentable character will be replaced
119 with the Encode substitution character (normally \f(CW\*(C`?\*(C'\fR).
120 .Sp
121 WARNING: The input encoding of the POD source is independent from the output
122 encoding, and setting this option does not affect the interpretation of the
123 POD input. Unless your POD source is US\-ASCII, its encoding should be
124 declared with the \f(CW\*(C`=encoding\*(C'\fR command in the source, as near to the top of
125 the file as possible. If this is not done, Pod::Simple will will attempt to
126 guess the encoding and may be successful if it\*(Aqs Latin\-1 or UTF\-8, but it will
127 produce warnings. See \fBperlpod\fR\|(1) for more information.
128 .IP \fB\-\-errors\fR=\fIstyle\fR 4
129 .IX Item "--errors=style"
130 [2.5.0] Set the error handling style. \f(CW\*(C`die\*(C'\fR says to throw an exception on
131 any POD formatting error. \f(CW\*(C`stderr\*(C'\fR says to report errors on standard error,
132 but not to throw an exception. \f(CW\*(C`pod\*(C'\fR says to include a POD ERRORS section in
133 the resulting documentation summarizing the errors. \f(CW\*(C`none\*(C'\fR ignores POD
134 errors entirely, as much as possible.
135 .Sp
136 The default is \f(CW\*(C`die\*(C'\fR.
137 .IP \fB\-\-guesswork\fR=\fIrule\fR[,\fIrule\fR...] 4
138 .IX Item "--guesswork=rule[,rule...]"
139 [5.01] By default, \fBpod2text\fR applies some default formatting rules based on
140 guesswork and regular expressions that are intended to make writing Perl
141 documentation easier and require less explicit markup. These rules may not
142 always be appropriate, particularly for documentation that isn\*(Aqt about Perl.
143 This option allows turning all or some of it off.
144 .Sp
145 The special rule \f(CW\*(C`all\*(C'\fR enables all guesswork. This is also the default for
146 backward compatibility reasons. The special rule \f(CW\*(C`none\*(C'\fR disables all
147 guesswork. Otherwise, the value of this option should be a comma\-separated
148 list of one or more of the following keywords:
149 .RS 4
150 .IP quoting 4
151 .IX Item "quoting"
152 If no guesswork is enabled, any text enclosed in C<> is surrounded by
153 double quotes in nroff (terminal) output unless the contents are already
154 quoted. When this guesswork is enabled, quote marks will also be suppressed
155 for Perl variables, function names, function calls, numbers, and hex
156 constants.
157 .RE
158 .RS 4
159 .Sp
160 Any unknown guesswork name is silently ignored (for potential future
161 compatibility), so be careful about spelling.
162 .RE
163 .IP "\fB\-i\fR \fIindent\fR, \fB\-\-indent=\fR\fIindent\fR" 4
164 .IX Item "-i indent, --indent=indent"
165 [1.00] Set the number of spaces to indent regular text, and the default
166 indentation for \f(CW\*(C`=over\*(C'\fR blocks. Defaults to 4 spaces if this option isn\*(Aqt
167 given.
168 .IP "\fB\-h\fR, \fB\-\-help\fR" 4
169 .IX Item "-h, --help"
170 [1.00] Print out usage information and exit.
171 .IP "\fB\-l\fR, \fB\-\-loose\fR" 4
172 .IX Item "-l, --loose"
173 [1.00] Print a blank line after a \f(CW\*(C`=head1\*(C'\fR heading. Normally, no blank line
174 is printed after \f(CW\*(C`=head1\*(C'\fR, although one is still printed after \f(CW\*(C`=head2\*(C'\fR,
175 because this is the expected formatting for manual pages; if you\*(Aqre formatting
176 arbitrary text documents, using this option is recommended.
177 .IP "\fB\-m\fR \fIwidth\fR, \fB\-\-left\-margin\fR=\fIwidth\fR, \fB\-\-margin\fR=\fIwidth\fR" 4
178 .IX Item "-m width, --left-margin=width, --margin=width"
179 [1.24] The width of the left margin in spaces. Defaults to 0. This is the
180 margin for all text, including headings, not the amount by which regular text
181 is indented; for the latter, see \fB\-i\fR option.
182 .IP \fB\-\-nourls\fR 4
183 .IX Item "--nourls"
184 [2.5.0] Normally, L<> formatting codes with a URL but anchor text are
185 formatted to show both the anchor text and the URL. In other words:
186 .Sp
187 .Vb 1
188 \& L<foo|http://example.com/>
189 .Ve
190 .Sp
191 is formatted as:
192 .Sp
193 .Vb 1
194 \& foo <http://example.com/>
195 .Ve
196 .Sp
197 This flag, if given, suppresses the URL when anchor text is given, so this
198 example would be formatted as just \f(CW\*(C`foo\*(C'\fR. This can produce less cluttered
199 output in cases where the URLs are not particularly important.
200 .IP "\fB\-o\fR, \fB\-\-overstrike\fR" 4
201 .IX Item "-o, --overstrike"
202 [1.06] Format the output with overstrike printing. Bold text is rendered as
203 character, backspace, character. Italics and file names are rendered as
204 underscore, backspace, character. Many pagers, such as \fBless\fR, know how to
205 convert this to bold or underlined text.
206 .IP "\fB\-q\fR \fIquotes\fR, \fB\-\-quotes\fR=\fIquotes\fR" 4
207 .IX Item "-q quotes, --quotes=quotes"
208 [4.00] Sets the quote marks used to surround C<> text to \fIquotes\fR. If
209 \&\fIquotes\fR is a single character, it is used as both the left and right quote.
210 Otherwise, it is split in half, and the first half of the string is used as
211 the left quote and the second is used as the right quote.
212 .Sp
213 \&\fIquotes\fR may also be set to the special value \f(CW\*(C`none\*(C'\fR, in which case no quote
214 marks are added around C<> text.
215 .IP "\fB\-s\fR, \fB\-\-sentence\fR" 4
216 .IX Item "-s, --sentence"
217 [1.00] Assume each sentence ends with two spaces and try to preserve that
218 spacing. Without this option, all consecutive whitespace in non\-verbatim
219 paragraphs is compressed into a single space.
220 .IP \fB\-\-stderr\fR 4
221 .IX Item "--stderr"
222 [2.1.3] By default, \fBpod2text\fR dies if any errors are detected in the POD
223 input. If \fB\-\-stderr\fR is given and no \fB\-\-errors\fR flag is present, errors are
224 sent to standard error, but \fBpod2text\fR does not abort. This is equivalent to
225 \&\f(CW\*(C`\-\-errors=stderr\*(C'\fR and is supported for backward compatibility.
226 .IP "\fB\-t\fR, \fB\-\-termcap\fR" 4
227 .IX Item "-t, --termcap"
228 [1.00] Try to determine the width of the screen and the bold and underline
229 sequences for the terminal from termcap, and use that information in
230 formatting the output. Output will be wrapped at two columns less than the
231 width of your terminal device. Using this option requires that your system
232 have a termcap file somewhere where Term::Cap can find it and requires that
233 your system support termios. With this option, the output of \fBpod2text\fR will
234 contain terminal control sequences for your current terminal type.
235 .IP "\fB\-u\fR, \fB\-\-utf8\fR" 4
236 .IX Item "-u, --utf8"
237 [2.2.0] Set the output encoding to UTF\-8. This is equivalent to
238 \&\f(CW\*(C`\-\-encoding=UTF\-8\*(C'\fR and is supported for backward compatibility.
239 .IP "\fB\-w\fR, \fB\-\-width=\fR\fIwidth\fR, \fB\-\fR\fIwidth\fR" 4
240 .IX Item "-w, --width=width, -width"
241 [1.00] The column at which to wrap text on the right\-hand side. Defaults to
242 76, unless \fB\-t\fR is given, in which case it\*(Aqs two columns less than the width
243 of your terminal device.
244 .SH "EXIT STATUS"
245 .IX Header "EXIT STATUS"
246 As long as all documents processed result in some output, even if that output
247 includes errata (a \f(CW\*(C`POD ERRORS\*(C'\fR section generated with \f(CW\*(C`\-\-errors=pod\*(C'\fR),
248 \&\fBpod2text\fR will exit with status 0. If any of the documents being processed
249 do not result in an output document, \fBpod2text\fR will exit with status 1. If
250 there are syntax errors in a POD document being processed and the error
251 handling style is set to the default of \f(CW\*(C`die\*(C'\fR, \fBpod2text\fR will abort
252 immediately with exit status 255.
253 .SH DIAGNOSTICS
254 .IX Header "DIAGNOSTICS"
255 If \fBpod2text\fR fails with errors, see Pod::Text and Pod::Simple for
256 information about what those errors might mean. Internally, it can also
257 produce the following diagnostics:
258 .IP "\-c (\-\-color) requires Term::ANSIColor be installed" 4
259 .IX Item "-c (--color) requires Term::ANSIColor be installed"
260 (F) \fB\-c\fR or \fB\-\-color\fR were given, but Term::ANSIColor could not be loaded.
261 .ie n .IP "Unknown option: %s" 4
262 .el .IP "Unknown option: \f(CW%s\fR" 4
263 .IX Item "Unknown option: %s"
264 (F) An unknown command line option was given.
265 .PP
266 In addition, other Getopt::Long error messages may result from invalid
267 command\-line options.
268 .SH ENVIRONMENT
269 .IX Header "ENVIRONMENT"
270 .IP COLUMNS 4
271 .IX Item "COLUMNS"
272 If \fB\-t\fR is given, \fBpod2text\fR will take the current width of your screen from
273 this environment variable, if available. It overrides terminal width
274 information in TERMCAP.
275 .IP TERMCAP 4
276 .IX Item "TERMCAP"
277 If \fB\-t\fR is given, \fBpod2text\fR will use the contents of this environment
278 variable if available to determine the correct formatting sequences for your
279 current terminal device.
280 .SH AUTHOR
281 .IX Header "AUTHOR"
282 Russ Allbery <[email protected]>.
283 .SH "COPYRIGHT AND LICENSE"
284 .IX Header "COPYRIGHT AND LICENSE"
285 Copyright 1999\-2001, 2004, 2006, 2008, 2010, 2012\-2019, 2022, 2024 Russ
286 Allbery <[email protected]>
287 .PP
288 This program is free software; you may redistribute it and/or modify it
289 under the same terms as Perl itself.
290 .SH "SEE ALSO"
291 .IX Header "SEE ALSO"
292 Encode::Supported, Pod::Text, Pod::Text::Color,
293 Pod::Text::Overstrike, Pod::Text::Termcap, Pod::Simple, \fBperlpod\fR\|(1)
294 .PP
295 The current version of this script is always available from its web site at
296 <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
297 Perl core distribution as of 5.6.0.