.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Getopt::Long::Descriptive::Usage 3"
.TH Getopt::Long::Descriptive::Usage 3 2026-10-26 "perl v5.44.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 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 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\*(Aqt need to call this.  GLD 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.