CommandManagerWriteUsage Method

Writes usage help with a list of all the commands.

Definition

Namespace: Ookii.CommandLine.Commands
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
public void WriteUsage()

Remarks

This method writes usage help for the application, including a list of all subcommand names and their descriptions using the ParseOptionsUsageWriter property.

A command's name is retrieved from its CommandAttribute attribute, and the description is retrieved from its DescriptionAttribute attribute.

Commands that don't meet the criteria of the CommandOptionsCommandFilter predicate are not included.

If the CommandOptionsParentCommand property is , only commands without a ParentCommandAttribute attribute are included. If it is not , only commands where the type specified using the ParentCommandAttribute attribute matches the value of the property are included.

The automatic version command is included if the CommandOptionsAutoVersionCommand property is and the command name matches the name of the automatic version command, and not any other command name. The CommandOptionsCommandFilter and CommandOptionsParentCommand property also affect whether the version command is included.

See Also