Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Usage.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::Usage 3pm"
61 .TH Pod::Usage 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::Usage \- extracts POD documentation and shows usage information
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Pod::Usage;
72 \&
73 \& my $message_text = "This text precedes the usage message.";
74 \& my $exit_status = 2; ## The exit status to use
75 \& my $verbose_level = 0; ## The verbose level to use
76 \& my $filehandle = \e*STDERR; ## The filehandle to write to
77 \&
78 \& pod2usage($message_text);
79 \&
80 \& pod2usage($exit_status);
81 \&
82 \& pod2usage( { \-message => $message_text ,
83 \& \-exitval => $exit_status ,
84 \& \-verbose => $verbose_level,
85 \& \-output => $filehandle } );
86 \&
87 \& pod2usage( \-msg => $message_text ,
88 \& \-exitval => $exit_status ,
89 \& \-verbose => $verbose_level,
90 \& \-output => $filehandle );
91 \&
92 \& pod2usage( \-verbose => 2,
93 \& \-noperldoc => 1 );
94 \&
95 \& pod2usage( \-verbose => 2,
96 \& \-perlcmd => $path_to_perl,
97 \& \-perldoc => $path_to_perldoc,
98 \& \-perldocopt => $perldoc_options );
99 .Ve
100 .SH ARGUMENTS
101 .IX Header "ARGUMENTS"
102 \&\fBpod2usage\fR should be given either a single argument, or a list of
103 arguments corresponding to an associative array (a "hash"). When a single
104 argument is given, it should correspond to exactly one of the following:
105 .IP \(bu 4
106 A string containing the text of a message to print \fIbefore\fR printing
107 the usage message
108 .IP \(bu 4
109 A numeric value corresponding to the desired exit status
110 .IP \(bu 4
111 A reference to a hash
112 .PP
113 If more than one argument is given then the entire argument list is
114 assumed to be a hash. If a hash is supplied (either as a reference or
115 as a list) it should contain one or more elements with the following
116 keys:
117 .ie n .IP """\-message"" \fIstring\fR" 4
118 .el .IP "\f(CW\-message\fR \fIstring\fR" 4
119 .IX Item "-message string"
120 .PD 0
121 .ie n .IP """\-msg"" \fIstring\fR" 4
122 .el .IP "\f(CW\-msg\fR \fIstring\fR" 4
123 .IX Item "-msg string"
124 .PD
125 The text of a message to print immediately prior to printing the
126 program\*(Aqs usage message.
127 .ie n .IP """\-exitval"" \fIvalue\fR" 4
128 .el .IP "\f(CW\-exitval\fR \fIvalue\fR" 4
129 .IX Item "-exitval value"
130 The desired exit status to pass to the \fBexit()\fR function.
131 This should be an integer, or else the string \f(CW\*(C`NOEXIT\*(C'\fR to
132 indicate that control should simply be returned without
133 terminating the invoking process.
134 .ie n .IP """\-verbose"" \fIvalue\fR" 4
135 .el .IP "\f(CW\-verbose\fR \fIvalue\fR" 4
136 .IX Item "-verbose value"
137 The desired level of "verboseness" to use when printing the usage message.
138 If the value is 0, then only the "SYNOPSIS" and/or "USAGE" sections of the
139 pod documentation are printed. If the value is 1, then the "SYNOPSIS" and/or
140 "USAGE" sections, along with any section entitled "OPTIONS", "ARGUMENTS", or
141 "OPTIONS AND ARGUMENTS" is printed. If the corresponding value is 2 or more
142 then the entire manpage is printed, using perldoc if available; otherwise
143 Pod::Text is used for the formatting. For better readability, the
144 all\-capital headings are downcased, e.g. \f(CW\*(C`SYNOPSIS\*(C'\fR => \f(CW\*(C`Synopsis\*(C'\fR.
145 .Sp
146 The special verbosity level 99 requires to also specify the \-sections
147 parameter; then these sections are extracted and printed.
148 .ie n .IP """\-sections"" \fIspec\fR" 4
149 .el .IP "\f(CW\-sections\fR \fIspec\fR" 4
150 .IX Item "-sections spec"
151 There are two ways to specify the selection. Either a string (scalar)
152 representing a selection regexp for sections to be printed when \-verbose
153 is set to 99, e.g.
154 .Sp
155 .Vb 1
156 \& "NAME|SYNOPSIS|DESCRIPTION|VERSION"
157 .Ve
158 .Sp
159 With the above regexp all content following (and including) any of the
160 given \f(CW\*(C`=head1\*(C'\fR headings will be shown. It is possible to restrict the
161 output to particular subsections only, e.g.:
162 .Sp
163 .Vb 1
164 \& "DESCRIPTION/Algorithm"
165 .Ve
166 .Sp
167 This will output only the \f(CW\*(C`=head2 Algorithm\*(C'\fR heading and content within
168 the \f(CW\*(C`=head1 DESCRIPTION\*(C'\fR section. The regexp binding is stronger than the
169 section separator, such that e.g.:
170 .Sp
171 .Vb 1
172 \& "DESCRIPTION|OPTIONS|ENVIRONMENT/Caveats"
173 .Ve
174 .Sp
175 will print any \f(CW\*(C`=head2 Caveats\*(C'\fR section (only) within any of the three
176 \&\f(CW\*(C`=head1\*(C'\fR sections.
177 .Sp
178 Alternatively, an array reference of section specifications can be used:
179 .Sp
180 .Vb 2
181 \& pod2usage(\-verbose => 99, \-sections => [
182 \& qw(DESCRIPTION DESCRIPTION/Introduction) ] );
183 .Ve
184 .Sp
185 This will print only the content of \f(CW\*(C`=head1 DESCRIPTION\*(C'\fR and the
186 \&\f(CW\*(C`=head2 Introduction\*(C'\fR sections, but no other \f(CW\*(C`=head2\*(C'\fR, and no other
187 \&\f(CW\*(C`=head1\*(C'\fR either.
188 .ie n .IP """\-output"" \fIhandle\fR" 4
189 .el .IP "\f(CW\-output\fR \fIhandle\fR" 4
190 .IX Item "-output handle"
191 A reference to a filehandle, or the pathname of a file to which the
192 usage message should be written. The default is \f(CW\*(C`\e*STDERR\*(C'\fR unless the
193 exit value is less than 2 (in which case the default is \f(CW\*(C`\e*STDOUT\*(C'\fR).
194 .ie n .IP """\-input"" \fIhandle\fR" 4
195 .el .IP "\f(CW\-input\fR \fIhandle\fR" 4
196 .IX Item "-input handle"
197 A reference to a filehandle, or the pathname of a file from which the
198 invoking script\*(Aqs pod documentation should be read. It defaults to the
199 file indicated by \f(CW$0\fR (\f(CW$PROGRAM_NAME\fR for users of \fIEnglish.pm\fR).
200 .Sp
201 If you are calling \fBpod2usage()\fR from a module and want to display
202 that module\*(Aqs POD, you can use this:
203 .Sp
204 .Vb 2
205 \& use Pod::Find qw(pod_where);
206 \& pod2usage( \-input => pod_where({\-inc => 1}, _\|_PACKAGE_\|_) );
207 .Ve
208 .ie n .IP """\-pathlist"" \fIstring\fR" 4
209 .el .IP "\f(CW\-pathlist\fR \fIstring\fR" 4
210 .IX Item "-pathlist string"
211 A list of directory paths. If the input file does not exist, then it
212 will be searched for in the given directory list (in the order the
213 directories appear in the list). It defaults to the list of directories
214 implied by \f(CW$ENV{PATH}\fR. The list may be specified either by a reference
215 to an array, or by a string of directory paths which use the same path
216 separator as \f(CW$ENV{PATH}\fR on your system (e.g., \f(CW\*(C`:\*(C'\fR for Unix, \f(CW\*(C`;\*(C'\fR for
217 MSWin32 and DOS).
218 .ie n .IP """\-noperldoc""" 4
219 .el .IP \f(CW\-noperldoc\fR 4
220 .IX Item "-noperldoc"
221 By default, Pod::Usage will call perldoc when \-verbose >= 2 is specified.
222 This does not work well e.g. if the script was packed with PAR. This option
223 suppresses the external call to perldoc and uses the simple text formatter
224 (Pod::Text) to output the POD.
225 .ie n .IP """\-perlcmd""" 4
226 .el .IP \f(CW\-perlcmd\fR 4
227 .IX Item "-perlcmd"
228 By default, Pod::Usage will call perldoc when \-verbose >= 2 is
229 specified. In case of special or unusual Perl installations,
230 this option may be used to supply the path to a perl executable
231 which should run perldoc.
232 .ie n .IP """\-perldoc"" \fIpath\-to\-perldoc\fR" 4
233 .el .IP "\f(CW\-perldoc\fR \fIpath\-to\-perldoc\fR" 4
234 .IX Item "-perldoc path-to-perldoc"
235 By default, Pod::Usage will call perldoc when \-verbose >= 2 is
236 specified. In case perldoc is not installed where the perl interpreter
237 thinks it is (see Config), the \-perldoc option may be used to supply
238 the correct path to perldoc.
239 .ie n .IP """\-perldocopt"" \fIstring\fR" 4
240 .el .IP "\f(CW\-perldocopt\fR \fIstring\fR" 4
241 .IX Item "-perldocopt string"
242 By default, Pod::Usage will call perldoc when \-verbose >= 2 is specified.
243 This option may be used to supply options to perldoc. The
244 string may contain several, space\-separated options.
245 .SS "Formatting base class"
246 .IX Subsection "Formatting base class"
247 The default text formatter is Pod::Text. The base class for Pod::Usage can
248 be defined by pre\-setting \f(CW$Pod::Usage::Formatter\fR \fIbefore\fR
249 loading Pod::Usage, e.g.:
250 .PP
251 .Vb 2
252 \& BEGIN { $Pod::Usage::Formatter = \*(AqPod::Text::Termcap\*(Aq; }
253 \& use Pod::Usage qw(pod2usage);
254 .Ve
255 .PP
256 Pod::Usage uses Pod::Simple\*(Aqs \fB_handle_element_end()\fR method to implement
257 the section selection, and in case of verbosity < 2 it down\-cases the
258 all\-caps headings to first capital letter and rest lowercase, and adds
259 a colon/newline at the end of the headings, for better readability. Same for
260 verbosity = 99.
261 .SS "Pass\-through options"
262 .IX Subsection "Pass-through options"
263 The following options are passed through to the underlying text formatter.
264 See the manual pages of these modules for more information.
265 .PP
266 .Vb 1
267 \& alt code indent loose margin quotes sentence stderr utf8 width
268 .Ve
269 .SH DESCRIPTION
270 .IX Header "DESCRIPTION"
271 \&\fBpod2usage\fR will print a usage message for the invoking script (using
272 its embedded pod documentation) and then exit the script with the
273 desired exit status. The usage message printed may have any one of three
274 levels of "verboseness": If the verbose level is 0, then only a synopsis
275 is printed. If the verbose level is 1, then the synopsis is printed
276 along with a description (if present) of the command line options and
277 arguments. If the verbose level is 2, then the entire manual page is
278 printed.
279 .PP
280 Unless they are explicitly specified, the default values for the exit
281 status, verbose level, and output stream to use are determined as
282 follows:
283 .IP \(bu 4
284 If neither the exit status nor the verbose level is specified, then the
285 default is to use an exit status of 2 with a verbose level of 0.
286 .IP \(bu 4
287 If an exit status \fIis\fR specified but the verbose level is \fInot\fR, then the
288 verbose level will default to 1 if the exit status is less than 2 and
289 will default to 0 otherwise.
290 .IP \(bu 4
291 If an exit status is \fInot\fR specified but verbose level \fIis\fR given, then
292 the exit status will default to 2 if the verbose level is 0 and will
293 default to 1 otherwise.
294 .IP \(bu 4
295 If the exit status used is less than 2, then output is printed on
296 \&\f(CW\*(C`STDOUT\*(C'\fR. Otherwise output is printed on \f(CW\*(C`STDERR\*(C'\fR.
297 .PP
298 Although the above may seem a bit confusing at first, it generally does
299 "the right thing" in most situations. This determination of the default
300 values to use is based upon the following typical Unix conventions:
301 .IP \(bu 4
302 An exit status of 0 implies "success". For example, \fBdiff\|(1)\fR exits
303 with a status of 0 if the two files have the same contents.
304 .IP \(bu 4
305 An exit status of 1 implies possibly abnormal, but non\-defective, program
306 termination. For example, \fBgrep\|(1)\fR exits with a status of 1 if
307 it did \fInot\fR find a matching line for the given regular expression.
308 .IP \(bu 4
309 An exit status of 2 or more implies a fatal error. For example, \fBls\|(1)\fR
310 exits with a status of 2 if you specify an illegal (unknown) option on
311 the command line.
312 .IP \(bu 4
313 Usage messages issued as a result of bad command\-line syntax should go
314 to \f(CW\*(C`STDERR\*(C'\fR. However, usage messages issued due to an explicit request
315 to print usage (like specifying \fB\-help\fR on the command line) should go
316 to \f(CW\*(C`STDOUT\*(C'\fR, just in case the user wants to pipe the output to a pager
317 (such as \fBmore\|(1)\fR).
318 .IP \(bu 4
319 If program usage has been explicitly requested by the user, it is often
320 desirable to exit with a status of 1 (as opposed to 0) after issuing
321 the user\-requested usage message. It is also desirable to give a
322 more verbose description of program usage in this case.
323 .PP
324 \&\fBpod2usage\fR does not force the above conventions upon you, but it will
325 use them by default if you don\*(Aqt expressly tell it to do otherwise. The
326 ability of \fBpod2usage()\fR to accept a single number or a string makes it
327 convenient to use as an innocent looking error message handling function:
328 .PP
329 .Vb 3
330 \& use strict;
331 \& use Pod::Usage;
332 \& use Getopt::Long;
333 \&
334 \& ## Parse options
335 \& my %opt;
336 \& GetOptions(\e%opt, "help|?", "man", "flag1") || pod2usage(2);
337 \& pod2usage(1) if ($opt{help});
338 \& pod2usage(\-exitval => 0, \-verbose => 2) if ($opt{man});
339 \&
340 \& ## Check for too many filenames
341 \& pod2usage("$0: Too many files given.\en") if (@ARGV > 1);
342 .Ve
343 .PP
344 Some user\*(Aqs however may feel that the above "economy of expression" is
345 not particularly readable nor consistent and may instead choose to do
346 something more like the following:
347 .PP
348 .Vb 3
349 \& use strict;
350 \& use Pod::Usage qw(pod2usage);
351 \& use Getopt::Long qw(GetOptions);
352 \&
353 \& ## Parse options
354 \& my %opt;
355 \& GetOptions(\e%opt, "help|?", "man", "flag1") ||
356 \& pod2usage(\-verbose => 0);
357 \&
358 \& pod2usage(\-verbose => 1) if ($opt{help});
359 \& pod2usage(\-verbose => 2) if ($opt{man});
360 \&
361 \& ## Check for too many filenames
362 \& pod2usage(\-verbose => 2, \-message => "$0: Too many files given.\en")
363 \& if (@ARGV > 1);
364 .Ve
365 .PP
366 As with all things in Perl, \fIthere\*(Aqs more than one way to do it\fR, and
367 \&\fBpod2usage()\fR adheres to this philosophy. If you are interested in
368 seeing a number of different ways to invoke \fBpod2usage\fR (although by no
369 means exhaustive), please refer to "EXAMPLES".
370 .SS Scripts
371 .IX Subsection "Scripts"
372 The Pod::Usage distribution comes with a script pod2usage which offers
373 a command line interface to the functionality of Pod::Usage. See
374 pod2usage.
375 .SH EXAMPLES
376 .IX Header "EXAMPLES"
377 Each of the following invocations of \f(CWpod2usage()\fR will print just the
378 "SYNOPSIS" section to \f(CW\*(C`STDERR\*(C'\fR and will exit with a status of 2:
379 .PP
380 .Vb 1
381 \& pod2usage();
382 \&
383 \& pod2usage(2);
384 \&
385 \& pod2usage(\-verbose => 0);
386 \&
387 \& pod2usage(\-exitval => 2);
388 \&
389 \& pod2usage({\-exitval => 2, \-output => \e*STDERR});
390 \&
391 \& pod2usage({\-verbose => 0, \-output => \e*STDERR});
392 \&
393 \& pod2usage(\-exitval => 2, \-verbose => 0);
394 \&
395 \& pod2usage(\-exitval => 2, \-verbose => 0, \-output => \e*STDERR);
396 .Ve
397 .PP
398 Each of the following invocations of \f(CWpod2usage()\fR will print a message
399 of "Syntax error." (followed by a newline) to \f(CW\*(C`STDERR\*(C'\fR, immediately
400 followed by just the "SYNOPSIS" section (also printed to \f(CW\*(C`STDERR\*(C'\fR) and
401 will exit with a status of 2:
402 .PP
403 .Vb 1
404 \& pod2usage("Syntax error.");
405 \&
406 \& pod2usage(\-message => "Syntax error.", \-verbose => 0);
407 \&
408 \& pod2usage(\-msg => "Syntax error.", \-exitval => 2);
409 \&
410 \& pod2usage({\-msg => "Syntax error.", \-exitval => 2, \-output => \e*STDERR});
411 \&
412 \& pod2usage({\-msg => "Syntax error.", \-verbose => 0, \-output => \e*STDERR});
413 \&
414 \& pod2usage(\-msg => "Syntax error.", \-exitval => 2, \-verbose => 0);
415 \&
416 \& pod2usage(\-message => "Syntax error.",
417 \& \-exitval => 2,
418 \& \-verbose => 0,
419 \& \-output => \e*STDERR);
420 .Ve
421 .PP
422 Each of the following invocations of \f(CWpod2usage()\fR will print the
423 "SYNOPSIS" section and any "OPTIONS" and/or "ARGUMENTS" sections to
424 \&\f(CW\*(C`STDOUT\*(C'\fR and will exit with a status of 1:
425 .PP
426 .Vb 1
427 \& pod2usage(1);
428 \&
429 \& pod2usage(\-verbose => 1);
430 \&
431 \& pod2usage(\-exitval => 1);
432 \&
433 \& pod2usage({\-exitval => 1, \-output => \e*STDOUT});
434 \&
435 \& pod2usage({\-verbose => 1, \-output => \e*STDOUT});
436 \&
437 \& pod2usage(\-exitval => 1, \-verbose => 1);
438 \&
439 \& pod2usage(\-exitval => 1, \-verbose => 1, \-output => \e*STDOUT});
440 .Ve
441 .PP
442 Each of the following invocations of \f(CWpod2usage()\fR will print the
443 entire manual page to \f(CW\*(C`STDOUT\*(C'\fR and will exit with a status of 1:
444 .PP
445 .Vb 1
446 \& pod2usage(\-verbose => 2);
447 \&
448 \& pod2usage({\-verbose => 2, \-output => \e*STDOUT});
449 \&
450 \& pod2usage(\-exitval => 1, \-verbose => 2);
451 \&
452 \& pod2usage({\-exitval => 1, \-verbose => 2, \-output => \e*STDOUT});
453 .Ve
454 .SS "Recommended Use"
455 .IX Subsection "Recommended Use"
456 Most scripts should print some type of usage message to \f(CW\*(C`STDERR\*(C'\fR when a
457 command line syntax error is detected. They should also provide an
458 option (usually \f(CW\*(C`\-H\*(C'\fR or \f(CW\*(C`\-help\*(C'\fR) to print a (possibly more verbose)
459 usage message to \f(CW\*(C`STDOUT\*(C'\fR. Some scripts may even wish to go so far as to
460 provide a means of printing their complete documentation to \f(CW\*(C`STDOUT\*(C'\fR
461 (perhaps by allowing a \f(CW\*(C`\-man\*(C'\fR option). The following complete example
462 uses \fBPod::Usage\fR in combination with \fBGetopt::Long\fR to do all of these
463 things:
464 .PP
465 .Vb 3
466 \& use strict;
467 \& use Getopt::Long qw(GetOptions);
468 \& use Pod::Usage qw(pod2usage);
469 \&
470 \& my $man = 0;
471 \& my $help = 0;
472 \& ## Parse options and print usage if there is a syntax error,
473 \& ## or if usage was explicitly requested.
474 \& GetOptions(\*(Aqhelp|?\*(Aq => \e$help, man => \e$man) or pod2usage(2);
475 \& pod2usage(1) if $help;
476 \& pod2usage(\-verbose => 2) if $man;
477 \&
478 \& ## If no arguments were given, then allow STDIN to be used only
479 \& ## if it\*(Aqs not connected to a terminal (otherwise print usage)
480 \& pod2usage("$0: No files given.") if ((@ARGV == 0) && (\-t STDIN));
481 \&
482 \& _\|_END_\|_
483 \&
484 \& =head1 NAME
485 \&
486 \& sample \- Using GetOpt::Long and Pod::Usage
487 \&
488 \& =head1 SYNOPSIS
489 \&
490 \& sample [options] [file ...]
491 \&
492 \& Options:
493 \& \-help brief help message
494 \& \-man full documentation
495 \&
496 \& =head1 OPTIONS
497 \&
498 \& =over 4
499 \&
500 \& =item B<\-help>
501 \&
502 \& Prints a brief help message and exits.
503 \&
504 \& =item B<\-man>
505 \&
506 \& Prints the manual page and exits.
507 \&
508 \& =back
509 \&
510 \& =head1 DESCRIPTION
511 \&
512 \& B<This program> will read the given input file(s) and do something
513 \& useful with the contents thereof.
514 \&
515 \& =cut
516 .Ve
517 .SH CAVEATS
518 .IX Header "CAVEATS"
519 By default, \fBpod2usage()\fR will use \f(CW$0\fR as the path to the pod input
520 file. Unfortunately, not all systems on which Perl runs will set \f(CW$0\fR
521 properly (although if \f(CW$0\fR is not found, \fBpod2usage()\fR will search
522 \&\f(CW$ENV{PATH}\fR or else the list specified by the \f(CW\*(C`\-pathlist\*(C'\fR option).
523 If this is the case for your system, you may need to explicitly specify
524 the path to the pod docs for the invoking script using something
525 similar to the following:
526 .PP
527 .Vb 1
528 \& pod2usage(\-exitval => 2, \-input => "/path/to/your/pod/docs");
529 .Ve
530 .PP
531 In the pathological case that a script is called via a relative path
532 \&\fIand\fR the script itself changes the current working directory
533 (see "chdir" in perlfunc) \fIbefore\fR calling pod2usage, Pod::Usage will
534 fail even on robust platforms. Don\*(Aqt do that. Or use FindBin to locate
535 the script:
536 .PP
537 .Vb 2
538 \& use FindBin;
539 \& pod2usage(\-input => $FindBin::Bin . "/" . $FindBin::Script);
540 .Ve
541 .SH SUPPORT
542 .IX Header "SUPPORT"
543 This module is managed in a GitHub repository,
544 <https://github.com/Dual\-Life/Pod\-Usage> Feel free to fork and contribute, or
545 to clone and send patches!
546 .PP
547 Please use <https://github.com/Dual\-Life/Pod\-Usage/issues/new> to file a bug
548 report. The previous ticketing system,
549 <https://rt.cpan.org/Dist/Display.html?Queue=Pod\-Usage>, is deprecated for
550 this package.
551 .PP
552 More general questions or discussion about POD should be sent to the
553 \&\f(CW\*(C`pod\[email protected]\*(C'\fR mail list. Send an empty email to
554 \&\f(CW\*(C`pod\-people\[email protected]\*(C'\fR to subscribe.
555 .SH AUTHOR
556 .IX Header "AUTHOR"
557 Marek Rouchal <[email protected]>
558 .PP
559 Nicolas R <[email protected]>
560 .PP
561 Brad Appleton <[email protected]>
562 .PP
563 Based on code for \fBPod::Text::pod2text()\fR written by
564 Tom Christiansen <[email protected]>
565 .SH LICENSE
566 .IX Header "LICENSE"
567 Pod::Usage (the distribution) is licensed under the same terms as Perl.
568 .SH ACKNOWLEDGMENTS
569 .IX Header "ACKNOWLEDGMENTS"
570 Nicolas R (ATOOMIC) for setting up the Github repo and modernizing this
571 package.
572 .PP
573 rjbs for refactoring Pod::Usage to not use Pod::Parser any more.
574 .PP
575 Steven McDougall <[email protected]> for his help and patience with
576 re\-writing this manpage.
577 .SH "SEE ALSO"
578 .IX Header "SEE ALSO"
579 \&\fBPod::Usage\fR is now a standalone distribution, depending on
580 Pod::Text which in turn depends on Pod::Simple.
581 .PP
582 Pod::Perldoc, Getopt::Long, Pod::Find, FindBin,
583 Pod::Text, Pod::Text::Termcap, Pod::Simple