Seth Woolley's Man Viewer

Getopt::Std(3) - getopt, getopts - Process single-character switches with switch clustering - man 3 Getopt::Std

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Getopt::Std(3)         Perl Programmers Reference Guide         Getopt::Std(3)



NAME
       getopt(1,3,3 Getopt::Std), getopts - Process single-character switches with switch(1,n) clus-
       tering

SYNOPSIS
           use Getopt::Std;

           getopt(1,3,3 Getopt::Std)('oDI');    # -o, -D & -I take arg.  Sets $opt_* as a side effect.
           getopt(1,3,3 Getopt::Std)('oDI', \%opts);    # -o, -D & -I take arg.  Values in(1,8) %opts
           getopts('oif:');  # -o & -i are boolean flags, -f takes an argument
                             # Sets $opt_* as a side effect.
           getopts('oif:', \%opts);  # options as above. Values in(1,8) %opts

DESCRIPTION
       The getopt(1,3,3 Getopt::Std)() function processes single-character switches with switch(1,n)
       clustering.  Pass one argument which is a string(3,n) containing all
       switches that take an argument.  For each switch(1,n) found, sets $opt_x
       (where x is the switch(1,n) name) to the value of the argument if(3,n) an argu-
       ment is expected, or 1 otherwise.  Switches which take an argument
       don't care whether there is a space between the switch(1,n) and the argu-
       ment.

       The getopts() function is similar, but you should pass to it the list
       of all switches to be recognized.  If unspecified switches are found on
       the command-line, the user will be warned that an unknown option was
       given.

       Note that, if(3,n) your code is running under the recommended "use strict
       'vars'" pragma, you will need to declare these package variables with
       "our":

           our($opt_x, $opt_y);

       For those of you who don't like additional global variables being cre-
       ated, getopt(1,3,3 Getopt::Std)() and getopts() will also accept(2,8) a hash reference as an
       optional second argument.  Hash keys will be x (where x is the switch(1,n)
       name) with key values the value of the argument or 1 if(3,n) no argument is
       specified.

       To allow programs to process arguments that look(1,8,3 Search::Dict) like switches, but
       aren't, both functions will stop processing switches when they see the
       argument "--".  The "--" will be removed from @ARGV.

"--help" and "--version"
       If "-" is not a recognized switch(1,n) letter, getopts() supports arguments
       "--help" and "--version".  If "main::HELP_MESSAGE()" and/or "main::VER-
       SION_MESSAGE()" are defined, they are called; the arguments are the
       output file(1,n) handle, the name of option-processing package, its version(1,3,5),
       and the switches string.  If the subroutines are not defined, an
       attempt is made to generate intelligent messages; for best results,
       define $main::VERSION.

       If embedded documentation (in(1,8) pod format, see perlpod) is detected in(1,8)
       the script, "--help" will also show how to access(2,5) the documentation.

       Note that due to excessive paranoia, if(3,n) $Getopt::Std::STAN-
       DARD_HELP_VERSION isn't true (the default is false), then the messages
       are printed on STDERR, and the processing continues after the messages
       are printed.  This being the opposite of the standard-conforming behav-
       iour, it is strongly recommended to set(7,n,1 builtins) $Getopt::Std::STAN-
       DARD_HELP_VERSION to true.

       One can change the output file(1,n) handle of the messages by setting
       $Getopt::Std::OUTPUT_HELP_VERSION.  One can print the messages of
       "--help" (without the "Usage:" line) and "--version" by calling func-
       tions help_mess() and version_mess() with the switches string(3,n) as an
       argument.



perl v5.8.5                       2001-09-21                    Getopt::Std(3)

References for this manual (incoming links)