.\" 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::Usaginator 3pm"
.TH Getopt::Usaginator 3pm "2022-11-19" "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::Usaginator \- Conjure up a usage function for your applications
.SH "VERSION"
.IX Header "VERSION"
version 0.0012
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Getopt::Usaginator <<_END_;
\&
\&        Usage: xyzzy <options>
\&    
\&        \-\-derp          Derp derp derp         
\&        \-\-durp          Durp durp durp
\&        \-h, \-\-help      This usage
\&        
\&    _END_
\&
\&    # The \*(Aqusage\*(Aq subroutine is now installed
\&
\&    ...
\&
\&    $options = parse_options( @ARGV ); # Not supplied by Usaginator
\&
\&    usage if $options{help}; # Print usage and exit with status 0
\&
\&    if ( ! $options{derp} ) {
\&        # Print warning and usage and exit with status \-1
\&        usage "You should really derp";
\&    }
\&    
\&    if ( $options{durp} ) {
\&        # Print warning and usage and exit with status 2
\&        usage 2 => "\-\-durp is not ready yet";
\&    }
\&
\&    ...
\&
\&    usage 3 # Print usage and exit with status 3
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Getopt::Usaginator is a tool for creating a handy usage subroutine for commandline applications
.PP
It does not do any option parsing, but is best paired with Getopt::Long or any of the other myriad of option parsers
.SH "USAGE"
.IX Header "USAGE"
.SS "use Getopt::Usaginator <usage>"
.IX Subsection "use Getopt::Usaginator <usage>"
Install a \f(CW\*(C`usage\*(C'\fR subroutine configured with the <usage> text
.ie n .SS "$code = Getopt::Usaginator\->usaginator( <usage> )"
.el .SS "\f(CW$code\fP = Getopt::Usaginator\->usaginator( <usage> )"
.IX Subsection "$code = Getopt::Usaginator->usaginator( <usage> )"
Return a subroutine configured with the <usage> text
.SS "..."
.IX Subsection "..."
More advanced usage is possible, peek under the hood for more information
.PP
.Vb 1
\&    perldoc \-m Getopt::Usaginator
.Ve
.PP
An example:
.PP
.Vb 7
\&    use Getopt::Usaginator
\&        # Called with the error
\&        error => sub { ... },
\&        # Called when usage printing is needed
\&        usage => sub { ... },
\&        ...
\&    ;
.Ve
.SH "An example with Getopt::Long parsing"
.IX Header "An example with Getopt::Long parsing"
.Vb 1
\&    use Getopt::Usaginator ...
\&
\&    sub run {
\&        my $self = shift;
\&        my @arguments = @_;
\&    
\&        usage 0 unless @arguments;
\&
\&        my ( $help );
\&        {     
\&            local @ARGV = @arguments;                                  
\&            GetOptions(
\&                \*(Aqhelp|h|?\*(Aq => \e$help,
\&            );
\&        }
\&
\&        usage 0 if $help;
\&
\&        ...
\&    }
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&  Robert Krimen <robertkrimen@gmail.com>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by Robert Krimen.
.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.