Module luarocks.help

Module implementing the LuaRocks "help" command. This is a generic help display module, which uses a global table called "commands" to find commands to show help for; each command should be represented by a table containing "help" and "help_summary" fields.

Functions

run (command) Driver function for the "help" command.


Functions

run (command)
Driver function for the "help" command.

Parameters

  • command: string or nil: command to show help for; if not given, help summaries for all commands are shown.

Return value:

boolean or (nil, string): true if there were no errors or nil and an error message if an invalid command was requested.

Valid XHTML 1.0!