UsageWriterWriteCommandHelpInstruction Method

Writes an instruction on how to get help on a command.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1
C#
protected virtual void WriteCommandHelpInstruction(
	string argumentNamePrefix,
	string argumentName
)

Parameters

argumentNamePrefix  String
The argument name prefix for a help argument.
argumentName  String
The automatic help argument name.

Remarks

The base implementation writes a string like "Run 'executable command -Help' for more information on a command."

This method is called by the base implementation of the WriteCommandListUsageCore method if the IncludeCommandHelpInstruction property is . If that property is , it is assumed that every command has an argument matching the automatic help argument's name.

See Also