     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
    63
    64

    #[cfg(feature = "yaml")]
    use yaml_rust::Yaml;

    use App;
    use ArgMatches;

    /// The abstract representation of a command line subcommand.
    ///
    /// This struct describes all the valid options of the subcommand for the program. Subcommands are
    /// essentially "sub apps" and contain all the same possibilities (such as their own arguments,
    /// subcommands, and settings).
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use clap::{App, Arg, SubCommand};
    /// App::new("myprog")
    ///     .subcommand(
    ///         SubCommand::with_name("config")
    ///             .about("Used for configuration")
    ///             .arg(Arg::with_name("config_file")
    ///                 .help("The configuration file to use")
    ///                 .index(1)))
    /// # ;
    /// ```
    #[derive(Debug, Clone)]
    pub struct SubCommand<'a> {
        #[doc(hidden)]
        pub name: String,
        #[doc(hidden)]
        pub matches: ArgMatches<'a>,
    }

    impl<'a> SubCommand<'a> {
        /// Creates a new instance of a subcommand requiring a name. The name will be displayed
        /// to the user when they print version or help and usage information.
        ///
        /// # Examples
        ///
        /// ```rust
        /// # use clap::{App, Arg, SubCommand};
        /// App::new("myprog")
        ///     .subcommand(
        ///         SubCommand::with_name("config"))
        /// # ;
        /// ```
        pub fn with_name<'b>(name: &str) -> App<'a, 'b> {
            App::new(name)
        }

        /// Creates a new instance of a subcommand from a YAML (.yml) document
        ///
        /// # Examples
        ///
        /// ```ignore
        /// # use clap::{App, Arg, SubCommand};
        /// let sc_yaml = load_yaml!("test_subcommand.yml");
        /// let sc = SubCommand::from_yaml(sc_yaml);
        /// ```
        #[cfg(feature = "yaml")]
        pub fn from_yaml<'y>(yaml: &'y Yaml) -> App<'y, 'y> {
            App::from_yaml(yaml)
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)