CommandHelp encapsulates the information needed to generate a user help message for a given CommandSpec, optionally with a specific command identified to print help about. Use Help.general() or Help.for_command() to create a CommandHelp instance.
class box CommandHelp
new ref _create( parent': (CommandHelp box | None val), spec': CommandSpec box) : CommandHelp ref^
fun box fullname() : String val
fun box string() : String val
Renders the help message as a String.
fun box help_string() : String val
Prints the help message to an OutStream.
fun box print_help( os: OutStream tag) : None val
fun box _write_help( w: Writer ref) : None val
fun box _write_usage( w: Writer ref) : None val
fun box _write_options( w: Writer ref, options: Array[OptionSpec box] box) : None val
fun box _write_commands( w: Writer ref) : None val
fun box _list_commands( cs: CommandSpec box, cols: Array[(USize val , String val , String val)] ref, level: USize val) : None val
fun box _write_args( w: Writer ref, args: Array[ArgSpec val] box) : None val
fun box _any_options() : Bool val
fun box _all_options() : Array[OptionSpec box] ref
fun box _all_options_fill( options: Array[OptionSpec box] ref) : None val
© 2016-2018, The Pony Developers
© 2014-2015, Causality Ltd.
Licensed under the BSD 2-Clause License.
https://stdlib.ponylang.io/cli-CommandHelp