remove warnings during test time
[trollop:mainline.git] / README.txt
1 == trollop
2
3 by William Morgan (http://masanjin.net/)
4
5 Main page: http://trollop.rubyforge.org
6
7 Release announcements and comments: http://all-thing.net/label/trollop
8
9 Documentation quickstart: See Trollop.options and then Trollop::Parser#opt.
10 Also see the examples at http://trollop.rubyforge.org/.
11
12 == DESCRIPTION
13
14 Trollop is a commandline option parser for Ruby that just gets out of your
15 way. One line of code per option is all you need to write. For that, you get a
16 nice automatically-generated help page, robust option parsing, command
17 subcompletion, and sensible defaults for everything you don't specify.
18
19 == FEATURES/PROBLEMS
20
21 - Dirt-simple usage.
22 - Sensible defaults. No tweaking necessary, much tweaking possible.
23 - Support for long options, short options, short option bundling, and
24   automatic type validation and conversion.
25 - Support for subcommands.
26 - Automatic help message generation, wrapped to current screen width.
27 - Lots of unit tests.
28
29 == REQUIREMENTS
30
31 * A burning desire to write less code.
32
33 == INSTALL
34
35 * gem install trollop
36
37 == SYNOPSIS
38
39   require 'trollop'
40   opts = Trollop::options do
41     opt :monkey, "Use monkey mode"                     # flag --monkey, default false
42     opt :goat, "Use goat mode", :default => true       # flag --goat, default true
43     opt :num_limbs, "Number of limbs", :default => 4   # integer --num-limbs <i>, default to 4
44     opt :num_thumbs, "Number of thumbs", :type => :int # integer --num-thumbs <i>, default nil
45   end
46
47   p opts # a hash: { :monkey => false, :goat => true, :num_limbs => 4, :num_thumbs => nil }
48
49 == LICENSE
50
51 Copyright (c) 2008--2009 William Morgan. Trollop is distributed under the same
52 terms as Ruby.