clap/src/lib.rs

91 lines
2.7 KiB
Rust
Raw Normal View History

2015-02-28 03:19:48 +00:00
#![crate_type= "lib"]
2015-03-01 21:58:39 +00:00
#![feature(collections, core, libc)]
2015-02-26 21:25:40 +00:00
2015-02-28 03:19:48 +00:00
//! A simply library for parsing command line arguments when writing
2015-02-28 14:40:53 +00:00
//! command line and console applications.
//!
//!
//! You can use `clap` to lay out a list of possible valid command line arguments and let `clap` parse the string given by the user at runtime.
//! When using `clap` you define a set of parameters and rules for your arguments and at runtime `clap` will determine their validity.
//! Also, `clap` provides the traditional version and help switches 'for free' by parsing the list of possible valid arguments lazily at runtime.
//! i.e. only when it's been determined that the user wants or needs to see the help and version information.
//!
//! After defining a list of possible valid arguments you get a list of matches that the user supplied at runtime. You can then use this list to
//! determine the functioning of your program.
//!
//! Example:
//!
2015-03-01 21:58:39 +00:00
//! ```no_run
//! use clap::{Arg, App};
//!
//! // ...
//!
//! let matches = App::new("MyApp")
//! .version("1.0")
//! .author("Kevin K. <kbknapp@gmail.com>")
//! .about("Does awesome things")
//! .arg(Arg::new("config")
//! .short("c")
//! .long("config")
//! .help("Sets a custom config file")
//! .takes_value(true))
//! .arg(Arg::new("output")
//! .help("Sets an optional output file")
2015-02-28 18:18:47 +00:00
//! .index(1))
//! .arg(Arg::new("debug")
//! .short("d")
//! .multiple(true)
//! .help("Turn debugging information on"))
//! .get_matches();
//!
//! if let Some(o) = matches.value_of("output") {
//! println!("Value for output: {}", o);
//! }
//!
//! if let Some(c) = matches.value_of("config") {
//! println!("Value for config: {}", c);
//! }
//!
//! match matches.occurrences_of("debug") {
//! 0 => println!("Debug mode is off"),
//! 1 => println!("Debug mode is kind of on"),
//! 2 => println!("Debug mode is on"),
//! 3 | _ => println!("Don't be crazy"),
//! }
//!
//! // more porgram logic goes here...
//! ```
2015-02-28 18:18:47 +00:00
//!
//! If you were to compile the above program and run it with the flag `--help` or `-h` the following output woud be presented
//!
//! ```sh
//! $ myprog --help
//! MyApp 1.0
//! Kevin K. <kbknapp@gmail.com>
//! Does awesome things
//!
2015-02-28 18:49:33 +00:00
//! USAGE:
//! MyApp [FLAGS] [OPTIONS] [POSITIONAL]
2015-02-28 18:18:47 +00:00
//!
//! FLAGS:
2015-03-01 01:15:04 +00:00
//! d--help Turn debugging information on
//! h--version,--help Prints this message
//! vd--help,--version Prints version information
2015-02-28 18:18:47 +00:00
//!
//! OPTIONS:
2015-03-01 01:15:04 +00:00
//! ch--version,--config <config> Sets a custom config file
2015-02-28 18:49:33 +00:00
//!
2015-02-28 18:18:47 +00:00
//! POSITIONAL ARGUMENTS:
2015-03-01 01:15:04 +00:00
//! output Sets an optional output file
2015-02-28 18:18:47 +00:00
//! ```
2015-02-28 03:19:48 +00:00
2015-02-28 15:45:31 +00:00
pub use argmatches::ArgMatches;
2015-02-25 13:37:25 +00:00
pub use arg::Arg;
pub use app::App;
mod app;
mod argmatches;
mod arg;
mod args;