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.103
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

METHODS

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

AUTHORS

61       ·   Hans Dieter Pearcey <hdp@cpan.org>
62
63       ·   Ricardo Signes <rjbs@cpan.org>
64

66       This software is copyright (c) 2005 by Hans Dieter Pearcey.
67
68       This is free software; you can redistribute it and/or modify it under
69       the same terms as the Perl 5 programming language system itself.
70
71
72
73perl v5.28.1                      2018-08-02Getopt::Long::Descriptive::Usage(3)
Impressum