Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

RedHat 9 (Linux i386) - man page for getopt::std (redhat section 3pm)

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

NAME
       getopt - Process single-character switches with switch clustering

       getopts - Process single-character switches with switch clustering

SYNOPSIS
	   use Getopt::Std;

	   getopt('oDI');    # -o, -D & -I take arg.  Sets $opt_* as a side effect.
	   getopt('oDI', \%opts);    # -o, -D & -I take arg.  Values in %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 %opts

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

       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 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 created, getopt() and
       getopts() will also accept a hash reference as an optional second argument.  Hash keys
       will be x (where x is the switch name) with key values the value of the argument or 1 if
       no argument is specified.

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

perl v5.8.0				    2002-06-01				 Getopt::Std(3pm)


All times are GMT -4. The time now is 03:24 AM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password