File: README.md

package info (click to toggle)
ruby-cmdparse 3.0.7-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 312 kB
  • sloc: ruby: 1,736; makefile: 11
file content (62 lines) | stat: -rw-r--r-- 1,495 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
**cmdparse** - an advanced command line parser using optparse which has support for commands

Copyright (C) 2004-2020 Thomas Leitner

## Description

Some programs use a "command style" command line. Examples for such programs are the "gem" program
from Rubygems and the "svn" program from Subversion. The standard Ruby distribution has no library
to create programs that use such a command line interface.

This library, cmdparse, can be used to create such a command line interface. Internally it uses
optparse to parse options and it provides a nice API for specifying commands.

See <https://cmdparse.gettalong.org> for detailed information, an extensive tutorial and the API
reference!


## Documentation

You can build the documentation by invoking

    $ rake doc

This builds the whole documentation and needs webgen >=1.4.0 (https://webgen.gettalong.org) for
building.


## Example Usage

There is an example of how to use cmdparse in the `example/net.rb` file. A detailed walkthrough of
what each part does can be found on <https://cmdparse.gettalong.org/tutorial.html>.


## License

MIT - see COPYING.


## Dependencies

none


## Installation

The preferred way of installing cmdparse is via RubyGems:

    $ gem install cmdparse

If you don't want to use RubyGems, use these commands:

    $ ruby setup.rb config
    $ ruby setup.rb setup
    $ ruby setup.rb install


## Contact

Author: Thomas Leitner

* Web: <https://cmdparse.gettalong.org>
* e-Mail: <mailto:t_leitner@gmx.at>