.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Getopt::Long::Descriptive::Usage 3pm"
.TH Getopt::Long::Descriptive::Usage 3pm "2023-01-07" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Getopt::Long::Descriptive::Usage \- the usage description for GLD
.SH "VERSION"
.IX Header "VERSION"
version 0.111
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Getopt::Long::Descriptive;
\&  my ($opt, $usage) = describe_options( ... );
\&
\&  $usage\->text; # complete usage message
\&
\&  $usage\->die;  # die with usage message
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This document only describes the methods of the Usage object.  For information
on how to use Getopt::Long::Descriptive, consult its documentation.
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This library should run on perls released even a long time ago.  It should work
on any version of perl released in the last five years.
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to lower
the minimum required perl.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&  my $usage = Getopt::Long::Descriptive::Usage\->new(\e%arg);
.Ve
.PP
You \fBreally\fR don't need to call this.  \s-1GLD\s0 will do it for you.
.PP
Valid arguments are:
.PP
.Vb 2
\&  options     \- an arrayref of options
\&  leader_text \- the text that leads the usage; this may go away!
.Ve
.SS "text"
.IX Subsection "text"
This returns the full text of the usage message.
.SS "leader_text"
.IX Subsection "leader_text"
This returns the text that comes at the beginning of the usage message.
.SS "option_text"
.IX Subsection "option_text"
This returns the text describing the available options.
.SS "warn"
.IX Subsection "warn"
This warns with the usage message.
.SS "die"
.IX Subsection "die"
This throws the usage message as an exception.
.PP
.Vb 1
\&  $usage_obj\->die(\e%arg);
.Ve
.PP
Some arguments can be provided
.PP
.Vb 2
\&  pre_text  \- text to be prepended to the usage message
\&  post_text \- text to be appended to the usage message
.Ve
.PP
The \f(CW\*(C`pre_text\*(C'\fR and \f(CW\*(C`post_text\*(C'\fR arguments are concatenated with the usage
message with no line breaks, so supply this if you need them.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Hans Dieter Pearcey <hdp@cpan.org>
.IP "\(bu" 4
Ricardo Signes <cpan@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2005 by Hans Dieter Pearcey.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.