aboutsummaryrefslogtreecommitdiff
path: root/clap/examples/02_apps.rs
diff options
context:
space:
mode:
Diffstat (limited to 'clap/examples/02_apps.rs')
-rw-r--r--clap/examples/02_apps.rs30
1 files changed, 30 insertions, 0 deletions
diff --git a/clap/examples/02_apps.rs b/clap/examples/02_apps.rs
new file mode 100644
index 0000000..8e45640
--- /dev/null
+++ b/clap/examples/02_apps.rs
@@ -0,0 +1,30 @@
+extern crate clap;
+
+use clap::App;
+
+fn main() {
+ // Apps describe the top level application
+ //
+ // You create an App and set various options on that App using the "builder pattern"
+ //
+ // The options (version(), author(), about()) aren't mandatory, but recommended. There is
+ // another option, usage(), which is an exception to the rule. This should only be used when
+ // the default usage string automatically generated by clap doesn't suffice.
+ //
+ // You also set all the valid arguments your App should accept via the arg(), args(), arg_from_usage()
+ // and args_from_usage() (as well as subcommands via the subcommand() and subcommands() methods) which
+ // will be covered later.
+ //
+ // Once all options have been set, call one of the .get_matches* family of methods in order to
+ // start the parsing and find all valid command line arguments that supplied by the user at
+ // runtime. The name given to new() will be displayed when the version or help flags are used.
+ App::new("MyApp")
+ .version("1.0")
+ .author("Kevin K. <kbknapp@gmail.com>")
+ .about("Does awesome things")
+ .get_matches();
+
+ // This example doesn't do much, but it *does* give automatic -h, --help, -V, and --version functionality ;)
+
+ // Continued program logic goes here...
+}