UsageWriterWriteCommandListUsage Method

Creates usage help for the specified command manager.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public void WriteCommandListUsage(
	CommandManager manager
)

Parameters

manager  CommandManager
The Ookii.CommandLine.CommandsCommandManager

Remarks

The usage help will contain a list of all available commands.

If no writer was passed to the UsageWriter(LineWrappingTextWriter, NullableBoolean) constructor, this method will create a LineWrappingTextWriter for the standard output stream. If color usage wasn't explicitly enabled, it will be enabled if the output supports it according to VirtualTerminalEnableColor(StandardStream).

This method calls the WriteCommandListUsageCore method to create the usage help text.

Exceptions

See Also