CommandLineParserWriteUsage Method

Writes command line usage help to the specified TextWriter using the specified options.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1
C#
public void WriteUsage(
	UsageWriter? usageWriter = null
)

Parameters

usageWriter  UsageWriter  (Optional)
The UsageWriter to use to create the usage. If , the value from the UsageWriter property in the Options property is sued.

Remarks

The usage help consists of first the Description, followed by the usage syntax, followed by a description of all the arguments.

You can add descriptions to the usage text by applying the DescriptionAttribute attribute to your command line arguments type, and the constructor parameters and properties defining command line arguments.

Color is applied to the output only if the UsageWriter instance has enabled it.

See Also