1Getopt::Long::DescriptiUvsee:r:UCsoangter(i3b)uted PerlGDeotcoupmte:n:tLaotnigo:n:Descriptive::Usage(3)
2
3
4

NAME

6       Getopt::Long::Descriptive::Usage - the usage description for GLD
7

VERSION

9       version 0.111
10

SYNOPSIS

12         use Getopt::Long::Descriptive;
13         my ($opt, $usage) = describe_options( ... );
14
15         $usage->text; # complete usage message
16
17         $usage->die;  # die with usage message
18

DESCRIPTION

20       This document only describes the methods of the Usage object.  For
21       information on how to use Getopt::Long::Descriptive, consult its
22       documentation.
23

PERL VERSION

25       This library should run on perls released even a long time ago.  It
26       should work on any version of perl released in the last five years.
27
28       Although it may work on older versions of perl, no guarantee is made
29       that the minimum required version will not be increased.  The version
30       may be increased for any reason, and there is no promise that patches
31       will be accepted to lower the minimum required perl.
32

METHODS

34   new
35         my $usage = Getopt::Long::Descriptive::Usage->new(\%arg);
36
37       You really don't need to call this.  GLD will do it for you.
38
39       Valid arguments are:
40
41         options     - an arrayref of options
42         leader_text - the text that leads the usage; this may go away!
43
44   text
45       This returns the full text of the usage message.
46
47   leader_text
48       This returns the text that comes at the beginning of the usage message.
49
50   option_text
51       This returns the text describing the available options.
52
53   warn
54       This warns with the usage message.
55
56   die
57       This throws the usage message as an exception.
58
59         $usage_obj->die(\%arg);
60
61       Some arguments can be provided
62
63         pre_text  - text to be prepended to the usage message
64         post_text - text to be appended to the usage message
65
66       The "pre_text" and "post_text" arguments are concatenated with the
67       usage message with no line breaks, so supply this if you need them.
68

AUTHORS

70       •   Hans Dieter Pearcey <hdp@cpan.org>
71
72       •   Ricardo Signes <cpan@semiotic.systems>
73

75       This software is copyright (c) 2005 by Hans Dieter Pearcey.
76
77       This is free software; you can redistribute it and/or modify it under
78       the same terms as the Perl 5 programming language system itself.
79
80
81
82perl v5.36.0                      2023-01-20Getopt::Long::Descriptive::Usage(3)
Impressum