Module | Trollop |
In: |
lib/trollop.rb
|
lib/trollop.rb — trollop command-line processing library
Author: | William Morgan (mailto: wmorgan-trollop@masanjin.net) |
Copyright: | Copyright 2007 William Morgan |
License: | GNU GPL version 2 |
VERSION | = | "1.8.2" | ||
FLOAT_RE | = | /^-?((\d+(\.\d+)?)|(\.\d+))$/ | Regex for floating point numbers | |
PARAM_RE | = | /^-(-|\.$|[^\d\.])/ | Regex for parameters |
Informs the user that their usage of ‘arg’ was wrong, as detailed by ‘msg’, and dies. Example:
options do opt :volume, :default => 0.0 end die :volume, "too loud" if opts[:volume] > 10.0 die :volume, "too soft" if opts[:volume] < 0.1
In the one-argument case, simply print that message, a notice about -h, and die. Example:
options do opt :whatever # ... end Trollop::die "need at least one filename" if ARGV.empty?
The top-level entry method into Trollop. Creates a Parser object, passes the block to it, then parses args with it, handling any errors or requests for help or version information appropriately (and then exiting). Modifies args in place. Returns a hash of option values.
The block passed in should contain one or more calls to opt (Parser#opt), one or more calls to text (Parser#text), and probably a call to version (Parser#version).
See the synopsis in README.txt for examples.