UsageWriter.IncludeCommandHelpInstruction Property

Gets or sets a value that indicates whether a message is shown at the bottom of the command list that instructs the user how to get help for individual commands.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.0.0
C#
public bool IncludeCommandHelpInstruction { get; set; }

Property Value

Boolean
true to show the instruction; otherwise, false. The default value is false.

Remarks

If set to true, the message is provided by the WriteCommandHelpInstruction(String, String) method. The default implementation of that method assumes that all commands have a help argument, the same ParsingMode, and the same argument prefixes. For that reason, showing this message is not enabled by default.

See Also