home *** CD-ROM | disk | FTP | other *** search
/ Netrunner 2004 October / NETRUNNER0410.ISO / regular / ActivePerl-5.8.4.810-MSWin32-x86.msi / _82c52777c08e79588b07da2958037f31 < prev    next >
Encoding:
Text File  |  2004-06-01  |  13.8 KB  |  439 lines
  1. Changes in version 2.34
  2. -----------------------
  3.  
  4. * Auto-vivification of array and hash refs
  5.  
  6.   If an option is specified to require an array or hash ref, and a
  7.   scalar reference is passed, this is auto-vivified to array or hash
  8.   ref. 
  9.  
  10.   Example:
  11.  
  12.     @ARGV = qw(--foo=xx);
  13.     GetOptions("foo=s@", \$var);
  14.     # Now $var->[0] eq "xx"
  15.  
  16. * Auto-supplied verbose and help options are no longer taken into
  17.   account when determining option ambiguity. This eliminates the
  18.   common problem that you suddenly get an ambiguous option warning
  19.   when you have an option "verbose" and run your program with "-v".
  20.  
  21. * Cosmetic changes in some error messages.
  22.  
  23. Changes in version 2.33
  24. -----------------------
  25.  
  26. **************** WARNING -- EXPERIMENTAL CODE AHEAD ****************
  27.  
  28. The following new features are marked experimental. This means that if
  29. you are going to use them you _must_ watch out for the next release of
  30. Getopt::Long to see if the API has changed.
  31.  
  32. * Getopt::Long can automatically handle --version and --help options
  33.   if the calling program did not specify a handler explicitly.
  34.  
  35.   Two configuration parameters have been added: 'auto_help' (or
  36.   'help') and 'auto_version' (or 'version'). If set, Getopt::Long will
  37.   itself take care of --help and --version options. Otherwise,
  38.   everything is exactly as it was before.
  39.  
  40.   The new features will be enabled by default for programs that
  41.   explicitly require version 2.3203 or later.
  42.  
  43.   Getopt::Long uses module Pod::Usage to produce the help message from
  44.   the SYNOPSIS section of the program's POD.
  45.  
  46.   Using a --help (or -?) command line option will write the SYNOPSIS
  47.   section of the program's POD to STDOUT, and exit with status 0.
  48.   However, an illegal option will produce the help text to STDERR,
  49.   and exit with status 2. This is in accordance with current
  50.   conventions.
  51.  
  52. * Two subroutines can be exported on demand:
  53.  
  54.   - VersionMessage
  55.  
  56.     This subroutine prints the standard version message.
  57.  
  58.   - HelpMessage
  59.  
  60.     This subroutine prints the standard help message.
  61.  
  62.   Both subroutines take the same arguments as Pod::Usage::pod2usage,
  63.   see its documentation for details.  
  64.  
  65.   Example:
  66.  
  67.     use Getopt::Long 2.33 qw(GetOptions HelpMessage);
  68.     GetOptions(...) or HelpMessage(2);
  69.  
  70. **************** END EXPERIMENTAL CODE ****************
  71.  
  72. * Subroutine Configure can now be exported on demand.
  73.  
  74. * Negatable options (with "!") now also support the "no-" prefix.
  75.   On request of Ed Avis.
  76.  
  77. * Some fixes with hashes and bundling.
  78.   Thanks to Anders Johnson and Andrei Gnepp.
  79.   Mandatory/optional status for hash values is now effective.
  80.   String valued options with no value now default to the empty string
  81.   instead of 1 (one).
  82.   NOTE: The hash options still remain more or less experimental.
  83.  
  84. * Fix a pass_through bug where the options terminator (normally "--")
  85.   was not passed through in @ARGV.
  86.   Thanks to Philippe Verdret.
  87.  
  88. * Add FAQ: I "use GetOpt::Long;" (Windows) and now it doesn't work.
  89.  
  90. Changes in version 2.32
  91. -----------------------
  92.  
  93. * Fix a bug where the initial value for a optional numeric argument
  94. was not used for value of a hash option.
  95.  
  96. * Remove 5.005 thread safety code. Getopt::Long is completely thread
  97. safe when using the 5.8 ithreads.
  98.  
  99. Changes in version 2.31
  100. -----------------------
  101.  
  102. * Fix a bug where calling the configure method on a
  103.   Getopt::Long::Parser object would bail out with 
  104.   Undefined subroutine &Getopt::Long::Parser::Configure called at
  105.   Getopt/Long.pm line 186.
  106.  
  107. Changes in version 2.30
  108. -----------------------
  109.  
  110. * Fix a problem where a 'die' from a 'warn' via a localized
  111.   $SIG{__WARN__} was not properly propagated from a callback.
  112.   Thanks to Diab Jerius.
  113.  
  114. Changes in version 2.29
  115. -----------------------
  116.  
  117. * Fix a problem where options were not recognized when both
  118.   auto_abbrev and ignore_case were disabled. Thanks to Seth Robertson.
  119.  
  120. * Remove Carp.
  121.  
  122. Changes in version 2.28
  123. -----------------------
  124.  
  125. * When an option is specified more than once, a warning is generated
  126.   if perl is run with -w. This is a correction to 2.27, where it would
  127.   unconditionally die.
  128.  
  129.   An example of duplicate specification is GetOptions('foo', 'foo'),
  130.   but also GetOptions('foo=s', 'foo') and GetOptions('Foo', 'foo')
  131.   (the latter only when ignore_case is in effect).
  132.  
  133. Changes in version 2.27
  134. -----------------------
  135.  
  136. * You can now specify integer options to take an optional argument.
  137.   that defaults to a specific value. E.g.,  GetOptions('foo:5' => \$var)
  138.   will allow $var to get the value 5 when no value was specified with
  139.   the -foo option on the command line.
  140.  
  141.   Instead of a value, a '+' may be specified. E.g.,
  142.   GetOptions('foo:+' => \$var) will allow $var to be incremented when
  143.   no value was specified with the -foo option on the command line.
  144.  
  145. * Fix several problems with internal and external use of 'die' and
  146.   signal handlers.
  147.  
  148. * Fixed some bugs with subtle combinations of bundling_override and
  149.   ignore_case.
  150.  
  151. * A callback routine that is associated with a hash-valued option will
  152.   now have both the hask key and the value passed. It used to get only
  153.   the value passed.
  154.  
  155. * Eliminated the use of autoloading. Autoloading kept generating
  156.   problems during development, and when using perlcc.
  157.  
  158. * Avoid errors on references when an option is found in error, e.g.
  159.   GetOptions('fo$@#' => \$var).
  160.   Thanks to Wolfgang Laun.
  161.  
  162. * When an option is specified more than once, an error is now
  163.   generated. E.g., GetOptions('foo', 'foo').
  164.   Thanks to Wolfgang Laun.
  165.  
  166. * Lots of internal restructoring to make room for extensions.
  167.  
  168. * Redesigned the regression tests.
  169.  
  170. * Enhance the documentation to prevent common misunderstandings about
  171.   single character options.
  172.  
  173. Changes in version 2.26
  174. -----------------------
  175.  
  176. * New option type: 'o'. It accepts all kinds of integral numbers in
  177.   Perl style, including decimal (24), octal (012), hexadecimal (0x2f)
  178.   and binary (0b1001).
  179.  
  180. * Fix problem with getopt_compat not matching +foo=bar.
  181.  
  182. * Remove $VERSION_STRING for production versions.
  183.  
  184. Changes in version 2.25
  185. -----------------------
  186.  
  187. * Change handling of a lone "-" on the command line. It will now be
  188.   treated as a non-option unless an explicit specification was passed
  189.   to GetOptions. See the manual.
  190.   In the old implementation an error was signalled, so no
  191.   compatibility breaks are expected from this change.
  192.  
  193. * Add $VERSION_STRING. This is the string form of $VERSION. Usually
  194.   they are identical, unless it is a pre-release in which case
  195.   $VERSION will be (e.g.) 2.2403 and $VERSION_STRING will be "2.24_03".
  196.  
  197. Changes in version 2.24
  198. -----------------------
  199.  
  200. * Add object oriented interface:
  201.  
  202.     use Getopt::Long;
  203.     $p = new Getopt::Long::Parser;
  204.     $p->configure(...configuration options...);
  205.     if ($p->getoptions(...options descriptions...)) ...
  206.  
  207. * Add configuration at 'use' time:
  208.  
  209.     use Getopt::Long qw(:config no_ignore_case bundling);
  210.  
  211. * Add configuration options "gnu_getopt" and "gnu_compat".
  212.  
  213.   "gnu_compat" controls whether --opt= is allowed, and what it should
  214.   do. Without "gnu_compat", --opt= gives an error. With "gnu_compat", 
  215.   --opt= will give option "opt" and empty value.
  216.   This is the way GNU getopt_long does it.
  217.  
  218.   "gnu_getopt" is a short way of setting "gnu_compat bundling permute
  219.   no_getopt_compat. With "gnu_getopt", command line handling should be
  220.   fully compatible with GNU getopt_long.
  221.  
  222. * Correct warnings when the user specified an array or hash
  223.   destination using a non-lowercase option, e.g. "I=s@".
  224.  
  225. * Correct ambiguous use of 'set' and 'reset' in the Configuration
  226.   section of the documentation. 
  227.  
  228. * Add configuration option "posix_default" to reset to defaults as if
  229.   POSIXLY_CORRECT were set.
  230.  
  231. * Disallow "no" prefix on configuration options "default", "prefix" and
  232.   "prefix_pattern". 
  233.  
  234. * Add a section "Trouble Shooting" to the documentation, with
  235.   frequently asked questions.
  236.  
  237. Changes in version 2.23
  238. -----------------------
  239.  
  240. * When a call-back routine issues 'die', messages starting with "!"
  241.   are treated specially. Currently, only "!FINISH" is recognised (see
  242.   the next bullet point). Other messages that start with "!" are
  243.   ignored.
  244.  
  245. * Change 'die("FINISH") (see changes in 2.21) to die("!FINISH"). This
  246.   is an incompatible change, but I guess noone is using this yet.
  247.  
  248. Changes in version 2.22
  249. -----------------------
  250.  
  251. * Fixes a bug in the combination of aliases and negation.
  252.  
  253.   Old:  "foo|bar!" allowed negation on foo, but not on bar.
  254.   New:  "foo|bar!" allows negation on foo and bar.
  255.  
  256.   Caveat: "foo|f!", with bundling, issues the warning that negation on
  257.   a short option is ignored. To obtain the desired behaviour, use
  258.  
  259.     "foo!" => \$opt_foo, "f" => \$opt_foo
  260.   or
  261.     "foo|f" => \$opt_foo, "nofoo" => sub { $opt_foo = 0 }
  262.  
  263.   Remember that this is _only_ required when bundling is in effect.
  264.  
  265. Changes in version 2.21
  266. -----------------------
  267.  
  268. * New documentation.
  269.  
  270. * User defined subroutines should use 'die' to signal errors.
  271.  
  272. * User defined subroutines can preliminary terminate options
  273.   processing by calling die("FINISH");
  274.  
  275. * Correct erroneous install of Getopt::Long manpage.
  276.   Previous versions seem to install Getopt::GetoptLong instead of
  277.   Getopt::Long.
  278.  
  279. Changes in version 2.20
  280. -----------------------
  281.  
  282. * Prevent the magic argument "<>" from being interpreted as option
  283.   starter characters if it is the first argument passed.
  284.   To use the characters "<>" as option starters, pass "><" instead.
  285.  
  286. * Changed license: Getopt::Long may now also be used under the Perl
  287.   Artistic License.
  288.  
  289. * Changed the file name of the distribution kit from "GetoptLong..."
  290.   to "Getopt-Long-..." to match the standards.
  291.  
  292. Changes in version 2.19
  293. -----------------------
  294.  
  295. * Fix a warning bug with bundling_override.
  296.  
  297. There's no version 2.18
  298. -----------------------
  299.  
  300. Changes in version 2.17
  301. -----------------------
  302.  
  303. * Getopt::Long::config is renamed Getopt::Long::Configure. The old
  304.   name will remain supported without being documented.
  305.  
  306. * Options can have the specifier '+' to denote that the option value
  307.   must be incremented each time the option occurs on the command line.
  308.   For example:
  309.  
  310.      my $more = 2;
  311.      Getopt::Long::Configure("bundling");
  312.      GetOptions ("v+" => \$more);
  313.      print STDOUT ("more = $more\n");
  314.  
  315.   will print "more = 3" when called with "-v", "more = 4" when called
  316.   with "-vv" (or "-v -v"), and so on.
  317.  
  318. * Getopt::Long now uses autoloading. This substantially reduces the
  319.   resources required to 'use Getopt::Long' (about 100 lines of over
  320.   1300 total).
  321.  
  322. * It is now documented that global option variables like $opt_foo
  323.   need to be declared using 'use vars ...' when running under 'use
  324.   strict'. 
  325.  
  326. * To install, it is now required to use the official procedure:
  327.  
  328.      perl Makefile.PL
  329.      make
  330.      make test
  331.      make install
  332.  
  333. Changes in version 2.16
  334. -----------------------
  335.  
  336. * A couple of small additional fixes to the $` $& $' fixes.
  337.  
  338. * The option prefix can be set using config("prefix=...") or, more
  339.   powerful, with config("prefix_pattern=..."); see the documentation
  340.   for details.
  341.  
  342. * More 'perl -w' warnings eliminated for obscure cases of bundling.
  343.  
  344. This version is identical to 2.15, which was not released.
  345.  
  346. There's no version 2.14
  347. -----------------------
  348.  
  349. Changes in version 2.13
  350. -----------------------
  351.  
  352. * All regexps are changed to avoid the use of $`, $& and $'. Using one
  353.   of these causes all pattern matches in the program to be much slower
  354.   than necessary.
  355.  
  356. * Configuration errors are signalled using die() and will cause the
  357.   program to be terminated (unless eval{...} or $SIG{__DIE__} is
  358.   used).
  359.  
  360. * Option parsing errors are now signalled with calls to warn().
  361.  
  362. * In option bundles, numeric values may be embedded in the bundle
  363.   (e.g. -al24w80).
  364.  
  365. * More 'perl -w' warnings eliminated for obscure cases of bundling.
  366.  
  367. * Removed non-standard version number matching. Version 1.121 is now
  368.   more than 1.12 but less than 1.13. 
  369.  
  370. Changes in version 2.12
  371. -----------------------
  372.  
  373. * A single question mark is allowed as an alias to an option, e.g. 
  374.  
  375.     GetOptions ("help|?", ...)
  376.  
  377. Changes in version 2.11
  378. -----------------------
  379.  
  380. * User linkage may be an object, provided the object is really a hash.
  381.  
  382.   For example:
  383.  
  384.     {    package Foo;
  385.     sub new () { return bless {}; }
  386.     }
  387.  
  388.     my $linkage = Foo->new();
  389.  
  390.     GetOptions ($linkage, ... );
  391.  
  392. * Some bug fixes in handling obscure cases of pass-through.
  393.  
  394. Changes in version 2.9
  395. ----------------------
  396.  
  397. * A new way to configure Getopt::Long. Instead of setting module local
  398.   variables, routine Getopt::Long::config can be called with the names
  399.   of options to be set or reset, e.g.
  400.  
  401.     Getopt::Long::config ("no_auto_abbrev", "ignore_case");
  402.  
  403.   Configuring by using the module local variables is deprecated, but
  404.   it will continue to work for backwark compatibility.
  405.  
  406. Changes in version 2.6
  407. ----------------------
  408.  
  409. * Handle ignorecase even if autoabbrev is off. 
  410.  
  411. * POD corrections.
  412.  
  413. Changes in version 2.4
  414. ----------------------
  415.  
  416. * Pass-through of unrecognized options. Makes it easy to write wrapper
  417.   programs that process some of the command line options but pass the
  418.   others to another program.
  419.  
  420. * Options can be of type HASH, now you can say
  421.  
  422.     --define foo=bar
  423.  
  424.   and have $opt_define{"foo"} set to "bar".
  425.  
  426. * An enhanced skeleton program, skel2.pl, that combines the power of
  427.   Getopt::Long with Pod::Usage. 
  428.   Module Pod::Usage can be obtained from CPAN,
  429.   http://www.perl.com/CPAN/authors/Brad_Appleton. 
  430.  
  431. Possible incompatibility in version 2.4
  432. ---------------------------------------
  433.  
  434. Previous versions of Getopt::Long always downcased the option variable
  435. names when ignorecase was in effect. This bug has been corrected. As a
  436. consequence, &GetOptions ("Foo") will now set variable $opt_Foo
  437. instead of $opt_foo.
  438.  
  439.