CommandLineHelpFormat

Inherits: Reference < Object

This class contains formatting options for constructing a help message in CommandLineParser.

Description

The class is used to pass formatting parameters to the CommandLineParser.get_help_text method.

Properties

bool	autogenerate_usage	true
String	footer	""
String	header	""
int	left_pad	2
int	line_length	80
int	min_description_length	40
int	right_pad	4
String	usage_title	""

Property Descriptions

• bool autogenerate_usage

Default	true
Setter	set_autogenerate_usage(value)
Getter	is_usage_autogenerated()

If true, the usage text will be automatically generated according to passed options.

---

• String footer

Default	""
Setter	set_footer(value)
Getter	get_footer()

Contains text to be displayed at the end of the help text.

---

• String header

Default	""
Setter	set_header(value)
Getter	get_header()

Contains text to be displayed at the beginning of the help text.

---

• int left_pad

Default	2
Setter	set_left_pad(value)
Getter	get_left_pad()

The amount of indentation in spaces to the left of the options in the help text.

---

• int line_length

Default	80
Setter	set_line_length(value)
Getter	get_line_length()

The maximum length of the line with option and description in help text. If the line exceeds this length, then its description will be split into several lines. See also min_description_length.

---

• int min_description_length

Default	40
Setter	set_min_description_length(value)
Getter	get_min_description_length()

The minimum description size used to split description when the line with option and description is too large. See also line_length.

---

• int right_pad

Default	4
Setter	set_right_pad(value)
Getter	get_right_pad()

The amount of indentation in spaces to the right of the options in the help text.

---

• String usage_title

Default	""
Setter	set_usage_title(value)
Getter	get_usage_title()

Title that will be displayed in usage text. If empty, the name of the current executable file will be used.