local-lib5/man/man3/Getopt::Long::Descriptive::Usage.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Getopt::Long::Descriptive::Usage 3"
 132 .TH Getopt::Long::Descriptive::Usage 3 "2009-12-03" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Getopt::Long::Descriptive::Usage \- the usage description for GLD
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  use Getopt::Long::Descriptive;
 139 \&  my ($opt, $usage) = describe_options( ... );
 140 .Ve
 141 .PP
 142 .Vb 1
 143 \&  $usage\->text; # complete usage message
 144 .Ve
 145 .PP
 146 .Vb 1
 147 \&  $usage\->die;  # die with usage message
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 This document only describes the methods of the Usage object.  For information
 152 on how to use Getopt::Long::Descriptive, consult its documentation.
 153 .SH "METHODS"
 154 .IX Header "METHODS"
 155 .Sh "new"
 156 .IX Subsection "new"
 157 .Vb 1
 158 \&  my $usage = Getopt::Long::Descriptive::Usage\->new(\e%arg);
 159 .Ve
 160 .PP
 161 You \fBreally\fR don't need to call this.  \s-1GLD\s0 will do it for you.
 162 .PP
 163 Valid arguments are:
 164 .PP
 165 .Vb 2
 166 \&  options     \- an arrayref of options
 167 \&  leader_text \- the text that leads the usage; this may go away!
 168 .Ve
 169 .Sh "text"
 170 .IX Subsection "text"
 171 This returns the full text of the usage message.
 172 .Sh "leader_text"
 173 .IX Subsection "leader_text"
 174 This returns the text that comes at the beginning of the usage message.
 175 .Sh "option_text"
 176 .IX Subsection "option_text"
 177 This returns the text describing the available options.
 178 .Sh "warn"
 179 .IX Subsection "warn"
 180 This warns with the usage message.
 181 .Sh "die"
 182 .IX Subsection "die"
 183 This throws the usage message as an exception.
 184 .PP
 185 .Vb 1
 186 \&  $usage_obj\->die(\e%arg);
 187 .Ve
 188 .PP
 189 Some arguments can be provided
 190 .PP
 191 .Vb 2
 192 \&  pre_text  \- text to be prepended to the usage message
 193 \&  post_text \- text to be appended to the usage message
 194 .Ve
 195 .PP
 196 The \f(CW\*(C`pre_text\*(C'\fR and \f(CW\*(C`post_text\*(C'\fR arguments are concatenated with the usage
 197 message with no line breaks, so supply this if you need them.
 198 .SH "AUTHOR"
 199 .IX Header "AUTHOR"
 200 Hans Dieter Pearcey, \f(CW\*(C`<hdp@cpan.org>\*(C'\fR
 201 .SH "BUGS"
 202 .IX Header "BUGS"
 203 Please report any bugs or feature requests through the web interface at
 204 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Getopt\-Long\-Descriptive>.  I
 205 will be notified, and then you'll automatically be notified of progress on your
 206 bug as I make changes.
 207 .SH "COPYRIGHT & LICENSE"
 208 .IX Header "COPYRIGHT & LICENSE"
 209 Copyright 2005 Hans Dieter Pearcey, all rights reserved.
 210 .PP
 211 This program is free software; you can redistribute it and/or modify it
 212 under the same terms as Perl itself.