gears::optparse::subcommand Struct Reference

Represents a command line subcommand. More...

Public Member Functions
	subcommand ()=default
	Default constructor.
	subcommand (std::string name)
	Constructs from a name.
	subcommand (std::string name, std::initializer_list< option > options)
	Constructs from a name and a list of options.
	subcommand (std::string name, std::string help, std::initializer_list< option > options)
	Constructs from a name, a help message and a list of options.
	subcommand (std::string name, std::string help, option_set options)
	Constructs from a name, a help message and an option set.
	subcommand (std::string name, option_set options)
	Constructs from a name and an option set.

Public Attributes
std::string	name
	The name of the subcommand.
std::string	description
	A brief paragraph giving an overview of the subcommand.
std::string	help
	A sentence explaining the subcommand. Shown in the help message.
std::string	usage = "[options..]"
	The usage message for the subcommand.
std::string	epilogue
	A paragraph usually printed after the help message.
option_set	options
	The options the subcommand contains.

Detailed Description

A subcommand is typically the first argument provided in the command line. Examples include things like svn checkout, git commit, git add, and more.

Definition at line 36 of file subcommand.hpp.