# Struct clap::SubCommand [−] [src]

    pub struct SubCommand<'a> {
        // some fields omitted
    }

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

    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)))

## Methods

### `impl<'a> SubCommand<'a>`

#### `fn with_name<'b>(name: &str) -> App<'a, 'b>`

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

    App::new("myprog")
        .subcommand(
            SubCommand::with_name("config"))

## Trait Implementations

### Derived Implementations

### `impl<'a> Clone for SubCommand<'a>`

#### `fn clone(&self) -> SubCommand<'a>`

#### `fn clone_from(&mut self, source: &Self)`1.0.0

### `impl<'a> Debug for SubCommand<'a>`

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`

# 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`)