Class HelpMessage

A block that prints a short manual for a program.

public sealed class HelpMessage : Block

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Creates a help message that uses the default GNU-style option printer.

public HelpMessage(Block summary, Inline usage, IReadOnlyList<Option> options)

Creates a help message.

public HelpMessage(Block summary, Inline usage, IReadOnlyList<Option> options, OptionPrinter printer)

Gets the supported command-line options.

public IReadOnlyList<Option> Options { get; }

Gets the option printer used to render option names and arguments.

public OptionPrinter Printer { get; }

Gets the program summary.

public Block Summary { get; }

Gets the program usage syntax.

public Inline Usage { get; }

Lowers this help message to simpler markup.

public override Block Lower()