path: root/upstream/debian-unstable/man3/Pod::Usage.3perl

.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Usage 3perl"
.TH Pod::Usage 3perl 2024-05-30 "perl v5.38.2" "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::Usage \- extracts POD documentation and shows usage information
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Pod::Usage;
\&
\&  my $message_text  = "This text precedes the usage message.";
\&  my $exit_status   = 2;          ## The exit status to use
\&  my $verbose_level = 0;          ## The verbose level to use
\&  my $filehandle    = \e*STDERR;   ## The filehandle to write to
\&
\&  pod2usage($message_text);
\&
\&  pod2usage($exit_status);
\&
\&  pod2usage( { \-message => $message_text ,
\&               \-exitval => $exit_status  ,
\&               \-verbose => $verbose_level,
\&               \-output  => $filehandle } );
\&
\&  pod2usage(   \-msg     => $message_text ,
\&               \-exitval => $exit_status  ,
\&               \-verbose => $verbose_level,
\&               \-output  => $filehandle );
\&
\&  pod2usage(   \-verbose => 2,
\&               \-noperldoc => 1  );
\&
\&  pod2usage(   \-verbose => 2,
\&               \-perlcmd => $path_to_perl,
\&               \-perldoc => $path_to_perldoc,
\&               \-perldocopt => $perldoc_options );
.Ve
.SH ARGUMENTS
.IX Header "ARGUMENTS"
\&\fBpod2usage\fR should be given either a single argument, or a list of
arguments corresponding to an associative array (a "hash"). When a single
argument is given, it should correspond to exactly one of the following:
.IP \(bu 4
A string containing the text of a message to print \fIbefore\fR printing
the usage message
.IP \(bu 4
A numeric value corresponding to the desired exit status
.IP \(bu 4
A reference to a hash
.PP
If more than one argument is given then the entire argument list is
assumed to be a hash.  If a hash is supplied (either as a reference or
as a list) it should contain one or more elements with the following
keys:
.ie n .IP """\-message"" \fIstring\fR" 4
.el .IP "\f(CW\-message\fR \fIstring\fR" 4
.IX Item "-message string"
.PD 0
.ie n .IP """\-msg"" \fIstring\fR" 4
.el .IP "\f(CW\-msg\fR \fIstring\fR" 4
.IX Item "-msg string"
.PD
The text of a message to print immediately prior to printing the
program's usage message.
.ie n .IP """\-exitval"" \fIvalue\fR" 4
.el .IP "\f(CW\-exitval\fR \fIvalue\fR" 4
.IX Item "-exitval value"
The desired exit status to pass to the \fBexit()\fR function.
This should be an integer, or else the string \f(CW\*(C`NOEXIT\*(C'\fR to
indicate that control should simply be returned without
terminating the invoking process.
.ie n .IP """\-verbose"" \fIvalue\fR" 4
.el .IP "\f(CW\-verbose\fR \fIvalue\fR" 4
.IX Item "-verbose value"
The desired level of "verboseness" to use when printing the usage message.
If the value is 0, then only the "SYNOPSIS" and/or "USAGE" sections of the
pod documentation are printed. If the value is 1, then the "SYNOPSIS" and/or
"USAGE" sections, along with any section entitled "OPTIONS", "ARGUMENTS", or
"OPTIONS AND ARGUMENTS" is printed. If the corresponding value is 2 or more
then the entire manpage is printed, using perldoc if available; otherwise
Pod::Text is used for the formatting. For better readability, the
all-capital headings are downcased, e.g. \f(CW\*(C`SYNOPSIS\*(C'\fR => \f(CW\*(C`Synopsis\*(C'\fR.
.Sp
The special verbosity level 99 requires to also specify the \-sections
parameter; then these sections are extracted and printed.
.ie n .IP """\-sections"" \fIspec\fR" 4
.el .IP "\f(CW\-sections\fR \fIspec\fR" 4
.IX Item "-sections spec"
There are two ways to specify the selection. Either a string (scalar)
representing a selection regexp for sections to be printed when \-verbose
is set to 99, e.g.
.Sp
.Vb 1
\&  "NAME|SYNOPSIS|DESCRIPTION|VERSION"
.Ve
.Sp
With the above regexp all content following (and including) any of the
given \f(CW\*(C`=head1\*(C'\fR headings will be shown. It is possible to restrict the
output to particular subsections only, e.g.:
.Sp
.Vb 1
\&  "DESCRIPTION/Algorithm"
.Ve
.Sp
This will output only the \f(CW\*(C`=head2 Algorithm\*(C'\fR heading and content within
the \f(CW\*(C`=head1 DESCRIPTION\*(C'\fR section. The regexp binding is stronger than the
section separator, such that e.g.:
.Sp
.Vb 1
\&  "DESCRIPTION|OPTIONS|ENVIRONMENT/Caveats"
.Ve
.Sp
will print any \f(CW\*(C`=head2 Caveats\*(C'\fR section (only) within any of the three
\&\f(CW\*(C`=head1\*(C'\fR sections.
.Sp
Alternatively, an array reference of section specifications can be used:
.Sp
.Vb 2
\&  pod2usage(\-verbose => 99, \-sections => [
\&    qw(DESCRIPTION DESCRIPTION/Introduction) ] );
.Ve
.Sp
This will print only the content of \f(CW\*(C`=head1 DESCRIPTION\*(C'\fR and the
\&\f(CW\*(C`=head2 Introduction\*(C'\fR sections, but no other \f(CW\*(C`=head2\*(C'\fR, and no other
\&\f(CW\*(C`=head1\*(C'\fR either.
.ie n .IP """\-output"" \fIhandle\fR" 4
.el .IP "\f(CW\-output\fR \fIhandle\fR" 4
.IX Item "-output handle"
A reference to a filehandle, or the pathname of a file to which the
usage message should be written. The default is \f(CW\*(C`\e*STDERR\*(C'\fR unless the
exit value is less than 2 (in which case the default is \f(CW\*(C`\e*STDOUT\*(C'\fR).
.ie n .IP """\-input"" \fIhandle\fR" 4
.el .IP "\f(CW\-input\fR \fIhandle\fR" 4
.IX Item "-input handle"
A reference to a filehandle, or the pathname of a file from which the
invoking script's pod documentation should be read.  It defaults to the
file indicated by \f(CW$0\fR (\f(CW$PROGRAM_NAME\fR for users of \fIEnglish.pm\fR).
.Sp
If you are calling \fBpod2usage()\fR from a module and want to display
that module's POD, you can use this:
.Sp
.Vb 2
\&  use Pod::Find qw(pod_where);
\&  pod2usage( \-input => pod_where({\-inc => 1}, _\|_PACKAGE_\|_) );
.Ve
.ie n .IP """\-pathlist"" \fIstring\fR" 4
.el .IP "\f(CW\-pathlist\fR \fIstring\fR" 4
.IX Item "-pathlist string"
A list of directory paths. If the input file does not exist, then it
will be searched for in the given directory list (in the order the
directories appear in the list). It defaults to the list of directories
implied by \f(CW$ENV{PATH}\fR. The list may be specified either by a reference
to an array, or by a string of directory paths which use the same path
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
MSWin32 and DOS).
.ie n .IP """\-noperldoc""" 4
.el .IP \f(CW\-noperldoc\fR 4
.IX Item "-noperldoc"
By default, Pod::Usage will call perldoc when \-verbose >= 2 is specified.
This does not work well e.g. if the script was packed with PAR. This option
suppresses the external call to perldoc and uses the simple text formatter
(Pod::Text) to output the POD.
.ie n .IP """\-perlcmd""" 4
.el .IP \f(CW\-perlcmd\fR 4
.IX Item "-perlcmd"
By default, Pod::Usage will call perldoc when \-verbose >= 2 is
specified. In case of special or unusual Perl installations,
this option may be used to supply the path to a perl executable
which should run perldoc.
.ie n .IP """\-perldoc"" \fIpath-to-perldoc\fR" 4
.el .IP "\f(CW\-perldoc\fR \fIpath-to-perldoc\fR" 4
.IX Item "-perldoc path-to-perldoc"
By default, Pod::Usage will call perldoc when \-verbose >= 2 is
specified. In case perldoc is not installed where the perl interpreter
thinks it is (see Config), the \-perldoc option may be used to supply
the correct path to perldoc.
.ie n .IP """\-perldocopt"" \fIstring\fR" 4
.el .IP "\f(CW\-perldocopt\fR \fIstring\fR" 4
.IX Item "-perldocopt string"
By default, Pod::Usage will call perldoc when \-verbose >= 2 is specified.
This option may be used to supply options to perldoc. The
string may contain several, space-separated options.
.SS "Formatting base class"
.IX Subsection "Formatting base class"
The default text formatter is Pod::Text. The base class for Pod::Usage can
be defined by pre-setting \f(CW$Pod::Usage::Formatter\fR \fIbefore\fR
loading Pod::Usage, e.g.:
.PP
.Vb 2
\&    BEGIN { $Pod::Usage::Formatter = \*(AqPod::Text::Termcap\*(Aq; }
\&    use Pod::Usage qw(pod2usage);
.Ve
.PP
Pod::Usage uses Pod::Simple's \fB_handle_element_end()\fR method to implement
the section selection, and in case of verbosity < 2 it down-cases the
all-caps headings to first capital letter and rest lowercase, and adds
a colon/newline at the end of the headings, for better readability. Same for
verbosity = 99.
.SS "Pass-through options"
.IX Subsection "Pass-through options"
The following options are passed through to the underlying text formatter.
See the manual pages of these modules for more information.
.PP
.Vb 1
\&  alt code indent loose margin quotes sentence stderr utf8 width
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpod2usage\fR will print a usage message for the invoking script (using
its embedded pod documentation) and then exit the script with the
desired exit status. The usage message printed may have any one of three
levels of "verboseness": If the verbose level is 0, then only a synopsis
is printed. If the verbose level is 1, then the synopsis is printed
along with a description (if present) of the command line options and
arguments. If the verbose level is 2, then the entire manual page is
printed.
.PP
Unless they are explicitly specified, the default values for the exit
status, verbose level, and output stream to use are determined as
follows:
.IP \(bu 4
If neither the exit status nor the verbose level is specified, then the
default is to use an exit status of 2 with a verbose level of 0.
.IP \(bu 4
If an exit status \fIis\fR specified but the verbose level is \fInot\fR, then the
verbose level will default to 1 if the exit status is less than 2 and
will default to 0 otherwise.
.IP \(bu 4
If an exit status is \fInot\fR specified but verbose level \fIis\fR given, then
the exit status will default to 2 if the verbose level is 0 and will
default to 1 otherwise.
.IP \(bu 4
If the exit status used is less than 2, then output is printed on
\&\f(CW\*(C`STDOUT\*(C'\fR.  Otherwise output is printed on \f(CW\*(C`STDERR\*(C'\fR.
.PP
Although the above may seem a bit confusing at first, it generally does
"the right thing" in most situations.  This determination of the default
values to use is based upon the following typical Unix conventions:
.IP \(bu 4
An exit status of 0 implies "success". For example, \fBdiff\|(1)\fR exits
with a status of 0 if the two files have the same contents.
.IP \(bu 4
An exit status of 1 implies possibly abnormal, but non-defective, program
termination.  For example, \fBgrep\|(1)\fR exits with a status of 1 if
it did \fInot\fR find a matching line for the given regular expression.
.IP \(bu 4
An exit status of 2 or more implies a fatal error. For example, \fBls\|(1)\fR
exits with a status of 2 if you specify an illegal (unknown) option on
the command line.
.IP \(bu 4
Usage messages issued as a result of bad command-line syntax should go
to \f(CW\*(C`STDERR\*(C'\fR.  However, usage messages issued due to an explicit request
to print usage (like specifying \fB\-help\fR on the command line) should go
to \f(CW\*(C`STDOUT\*(C'\fR, just in case the user wants to pipe the output to a pager
(such as \fBmore\|(1)\fR).
.IP \(bu 4
If program usage has been explicitly requested by the user, it is often
desirable to exit with a status of 1 (as opposed to 0) after issuing
the user-requested usage message.  It is also desirable to give a
more verbose description of program usage in this case.
.PP
\&\fBpod2usage\fR does not force the above conventions upon you, but it will
use them by default if you don't expressly tell it to do otherwise.  The
ability of \fBpod2usage()\fR to accept a single number or a string makes it
convenient to use as an innocent looking error message handling function:
.PP
.Vb 3
\&    use strict;
\&    use Pod::Usage;
\&    use Getopt::Long;
\&
\&    ## Parse options
\&    my %opt;
\&    GetOptions(\e%opt, "help|?", "man", "flag1")  ||  pod2usage(2);
\&    pod2usage(1)  if ($opt{help});
\&    pod2usage(\-exitval => 0, \-verbose => 2)  if ($opt{man});
\&
\&    ## Check for too many filenames
\&    pod2usage("$0: Too many files given.\en")  if (@ARGV > 1);
.Ve
.PP
Some user's however may feel that the above "economy of expression" is
not particularly readable nor consistent and may instead choose to do
something more like the following:
.PP
.Vb 3
\&    use strict;
\&    use Pod::Usage qw(pod2usage);
\&    use Getopt::Long qw(GetOptions);
\&
\&    ## Parse options
\&    my %opt;
\&    GetOptions(\e%opt, "help|?", "man", "flag1")  ||
\&      pod2usage(\-verbose => 0);
\&
\&    pod2usage(\-verbose => 1)  if ($opt{help});
\&    pod2usage(\-verbose => 2)  if ($opt{man});
\&
\&    ## Check for too many filenames
\&    pod2usage(\-verbose => 2, \-message => "$0: Too many files given.\en")
\&      if (@ARGV > 1);
.Ve
.PP
As with all things in Perl, \fIthere's more than one way to do it\fR, and
\&\fBpod2usage()\fR adheres to this philosophy.  If you are interested in
seeing a number of different ways to invoke \fBpod2usage\fR (although by no
means exhaustive), please refer to "EXAMPLES".
.SS Scripts
.IX Subsection "Scripts"
The Pod::Usage distribution comes with a script pod2usage which offers
a command line interface to the functionality of Pod::Usage. See
pod2usage.
.SH EXAMPLES
.IX Header "EXAMPLES"
Each of the following invocations of \f(CWpod2usage()\fR will print just the
"SYNOPSIS" section to \f(CW\*(C`STDERR\*(C'\fR and will exit with a status of 2:
.PP
.Vb 1
\&    pod2usage();
\&
\&    pod2usage(2);
\&
\&    pod2usage(\-verbose => 0);
\&
\&    pod2usage(\-exitval => 2);
\&
\&    pod2usage({\-exitval => 2, \-output => \e*STDERR});
\&
\&    pod2usage({\-verbose => 0, \-output  => \e*STDERR});
\&
\&    pod2usage(\-exitval => 2, \-verbose => 0);
\&
\&    pod2usage(\-exitval => 2, \-verbose => 0, \-output => \e*STDERR);
.Ve
.PP
Each of the following invocations of \f(CWpod2usage()\fR will print a message
of "Syntax error." (followed by a newline) to \f(CW\*(C`STDERR\*(C'\fR, immediately
followed by just the "SYNOPSIS" section (also printed to \f(CW\*(C`STDERR\*(C'\fR) and
will exit with a status of 2:
.PP
.Vb 1
\&    pod2usage("Syntax error.");
\&
\&    pod2usage(\-message => "Syntax error.", \-verbose => 0);
\&
\&    pod2usage(\-msg  => "Syntax error.", \-exitval => 2);
\&
\&    pod2usage({\-msg => "Syntax error.", \-exitval => 2, \-output => \e*STDERR});
\&
\&    pod2usage({\-msg => "Syntax error.", \-verbose => 0, \-output => \e*STDERR});
\&
\&    pod2usage(\-msg  => "Syntax error.", \-exitval => 2, \-verbose => 0);
\&
\&    pod2usage(\-message => "Syntax error.",
\&              \-exitval => 2,
\&              \-verbose => 0,
\&              \-output  => \e*STDERR);
.Ve
.PP
Each of the following invocations of \f(CWpod2usage()\fR will print the
"SYNOPSIS" section and any "OPTIONS" and/or "ARGUMENTS" sections to
\&\f(CW\*(C`STDOUT\*(C'\fR and will exit with a status of 1:
.PP
.Vb 1
\&    pod2usage(1);
\&
\&    pod2usage(\-verbose => 1);
\&
\&    pod2usage(\-exitval => 1);
\&
\&    pod2usage({\-exitval => 1, \-output => \e*STDOUT});
\&
\&    pod2usage({\-verbose => 1, \-output => \e*STDOUT});
\&
\&    pod2usage(\-exitval => 1, \-verbose => 1);
\&
\&    pod2usage(\-exitval => 1, \-verbose => 1, \-output => \e*STDOUT});
.Ve
.PP
Each of the following invocations of \f(CWpod2usage()\fR will print the
entire manual page to \f(CW\*(C`STDOUT\*(C'\fR and will exit with a status of 1:
.PP
.Vb 1
\&    pod2usage(\-verbose  => 2);
\&
\&    pod2usage({\-verbose => 2, \-output => \e*STDOUT});
\&
\&    pod2usage(\-exitval  => 1, \-verbose => 2);
\&
\&    pod2usage({\-exitval => 1, \-verbose => 2, \-output => \e*STDOUT});
.Ve
.SS "Recommended Use"
.IX Subsection "Recommended Use"
Most scripts should print some type of usage message to \f(CW\*(C`STDERR\*(C'\fR when a
command line syntax error is detected. They should also provide an
option (usually \f(CW\*(C`\-H\*(C'\fR or \f(CW\*(C`\-help\*(C'\fR) to print a (possibly more verbose)
usage message to \f(CW\*(C`STDOUT\*(C'\fR. Some scripts may even wish to go so far as to
provide a means of printing their complete documentation to \f(CW\*(C`STDOUT\*(C'\fR
(perhaps by allowing a \f(CW\*(C`\-man\*(C'\fR option). The following complete example
uses \fBPod::Usage\fR in combination with \fBGetopt::Long\fR to do all of these
things:
.PP
.Vb 3
\&    use strict;
\&    use Getopt::Long qw(GetOptions);
\&    use Pod::Usage qw(pod2usage);
\&
\&    my $man = 0;
\&    my $help = 0;
\&    ## Parse options and print usage if there is a syntax error,
\&    ## or if usage was explicitly requested.
\&    GetOptions(\*(Aqhelp|?\*(Aq => \e$help, man => \e$man) or pod2usage(2);
\&    pod2usage(1) if $help;
\&    pod2usage(\-verbose => 2) if $man;
\&
\&    ## If no arguments were given, then allow STDIN to be used only
\&    ## if it\*(Aqs not connected to a terminal (otherwise print usage)
\&    pod2usage("$0: No files given.")  if ((@ARGV == 0) && (\-t STDIN));
\&
\&    _\|_END_\|_
\&
\&    =head1 NAME
\&
\&    sample \- Using GetOpt::Long and Pod::Usage
\&
\&    =head1 SYNOPSIS
\&
\&    sample [options] [file ...]
\&
\&     Options:
\&       \-help            brief help message
\&       \-man             full documentation
\&
\&    =head1 OPTIONS
\&
\&    =over 4
\&
\&    =item B<\-help>
\&
\&    Print a brief help message and exits.
\&
\&    =item B<\-man>
\&
\&    Prints the manual page and exits.
\&
\&    =back
\&
\&    =head1 DESCRIPTION
\&
\&    B<This program> will read the given input file(s) and do something
\&    useful with the contents thereof.
\&
\&    =cut
.Ve
.SH CAVEATS
.IX Header "CAVEATS"
By default, \fBpod2usage()\fR will use \f(CW$0\fR as the path to the pod input
file.  Unfortunately, not all systems on which Perl runs will set \f(CW$0\fR
properly (although if \f(CW$0\fR is not found, \fBpod2usage()\fR will search
\&\f(CW$ENV{PATH}\fR or else the list specified by the \f(CW\*(C`\-pathlist\*(C'\fR option).
If this is the case for your system, you may need to explicitly specify
the path to the pod docs for the invoking script using something
similar to the following:
.PP
.Vb 1
\&    pod2usage(\-exitval => 2, \-input => "/path/to/your/pod/docs");
.Ve
.PP
In the pathological case that a script is called via a relative path
\&\fIand\fR the script itself changes the current working directory
(see "chdir" in perlfunc) \fIbefore\fR calling pod2usage, Pod::Usage will
fail even on robust platforms. Don't do that. Or use FindBin to locate
the script:
.PP
.Vb 2
\&    use FindBin;
\&    pod2usage(\-input => $FindBin::Bin . "/" . $FindBin::Script);
.Ve
.SH SUPPORT
.IX Header "SUPPORT"
This module is managed in a GitHub repository,
<https://github.com/Dual\-Life/Pod\-Usage> Feel free to fork and contribute, or
to clone and send patches!
.PP
Please use <https://github.com/Dual\-Life/Pod\-Usage/issues/new> to file a bug
report.  The previous ticketing system,
<https://rt.cpan.org/Dist/Display.html?Queue=Pod\-Usage>, is deprecated for
this package.
.PP
More general questions or discussion about POD should be sent to the
\&\f(CW\*(C`pod\-people@perl.org\*(C'\fR mail list. Send an empty email to
\&\f(CW\*(C`pod\-people\-subscribe@perl.org\*(C'\fR to subscribe.
.SH AUTHOR
.IX Header "AUTHOR"
Marek Rouchal <marekr@cpan.org>
.PP
Nicolas R <nicolas@atoomic.org>
.PP
Brad Appleton <bradapp@enteract.com>
.PP
Based on code for \fBPod::Text::pod2text()\fR written by
Tom Christiansen <tchrist@mox.perl.com>
.SH LICENSE
.IX Header "LICENSE"
Pod::Usage (the distribution) is licensed under the same terms as Perl.
.SH ACKNOWLEDGMENTS
.IX Header "ACKNOWLEDGMENTS"
Nicolas R (ATOOMIC) for setting up the Github repo and modernizing this
package.
.PP
rjbs for refactoring Pod::Usage to not use Pod::Parser any more.
.PP
Steven McDougall <swmcd@world.std.com> for his help and patience with
re-writing this manpage.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBPod::Usage\fR is now a standalone distribution, depending on
Pod::Text which in turn depends on Pod::Simple.
.PP
Pod::Perldoc, Getopt::Long, Pod::Find, FindBin,
Pod::Text, Pod::Text::Termcap, Pod::Simple