args::HelpParams Struct Reference

A simple structure of parameters for easy user-modifyable help menus. More...

#include <args.hxx>

Public Attributes
unsigned int	width = 80
	The width of the help menu.
unsigned int	progindent = 2
	The indent of the program line.
unsigned int	progtailindent = 4
	The indent of the program trailing lines for long parameters.
unsigned int	descriptionindent = 4
	The indent of the description and epilogs.
unsigned int	flagindent = 6
	The indent of the flags.
unsigned int	helpindent = 40
	The indent of the flag descriptions.
unsigned int	eachgroupindent = 2
	The additional indent each group adds.
unsigned int	gutter = 1
	The minimum gutter between each flag and its help.
bool	showTerminator = true
	Show the terminator when both options and positional parameters are present.
bool	showProglineOptions = true
	Show the {OPTIONS} on the prog line when this is true.
bool	showProglinePositionals = true
	Show the positionals on the prog line when this is true.
std::string	shortPrefix
	The prefix for short flags.
std::string	longPrefix
	The prefix for long flags.
std::string	shortSeparator
	The separator for short flags.
std::string	longSeparator
	The separator for long flags.
std::string	programName
	The program name for help generation.
bool	showCommandChildren = false
	Show command's flags.
bool	showCommandFullHelp = false
	Show command's descriptions and epilog.
std::string	proglineOptions = "{OPTIONS}"
	The postfix for progline when showProglineOptions is true and command has any flags.
std::string	proglineCommand = "COMMAND"
	The prefix for progline when command has any subcommands.
std::string	proglineValueOpen = " <"
	The prefix for progline value.
std::string	proglineValueClose = ">"
	The postfix for progline value.
std::string	proglineRequiredOpen = ""
	The prefix for progline required argument.
std::string	proglineRequiredClose = ""
	The postfix for progline required argument.
std::string	proglineNonrequiredOpen = "["
	The prefix for progline non-required argument.
std::string	proglineNonrequiredClose = "]"
	The postfix for progline non-required argument.
bool	proglineShowFlags = false
	Show flags in program line.
bool	proglinePreferShortFlags = false
	Use short flags in program lines when possible.
std::string	usageString
	Program line prefix.
std::string	optionsString = "OPTIONS:"
	String shown in help before flags descriptions.
bool	useValueNameOnce = false
	Display value name after all the long and short flags.
bool	showValueName = true
	Show value name.
bool	addNewlineBeforeDescription = false
	Add newline before flag description.
std::string	valueOpen = "["
	The prefix for option value.
std::string	valueClose = "]"
	The postfix for option value.
bool	addChoices = false
	Add choices to argument description.
std::string	choiceString = "\nOne of: "
	The prefix for choices.
bool	addDefault = false
	Add default values to argument description.
std::string	defaultString = "\nDefault: "
	The prefix for default values.

Detailed Description

A simple structure of parameters for easy user-modifyable help menus.

---

The documentation for this struct was generated from the following file:

• args.hxx