formatHelp

abstract fun formatHelp(error: UsageError?, prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String = ""): String

Return a help string to show the user.

Parameters

error

The error encountered, if there was one

prolog

Text to display before any parameter information

epilog

Text to display after any parameter information

parameters

Information about the command's parameters

programName

The name of the currently executing program