File size: 5,520 Bytes
7e9dc27 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
--- 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.
local help = {}
local util = require("luarocks.util")
local cfg = require("luarocks.core.cfg")
local dir = require("luarocks.dir")
local program = util.this_program("luarocks")
help.help_summary = "Help on commands. Type '"..program.." help <command>' for more."
help.help_arguments = "[<command>]"
help.help = [[
<command> is the command to show help for.
]]
local function print_banner()
util.printout("\nLuaRocks "..cfg.program_version..", the Lua package manager")
end
local function print_section(section)
util.printout("\n"..section)
end
local function get_status(status)
if status then
return "ok"
else
return "not found"
end
end
--- Driver function for the "help" command.
-- @param command string or nil: command to show help for; if not
-- given, help summaries for all commands are shown.
-- @return boolean or (nil, string): true if there were no errors
-- or nil and an error message if an invalid command was requested.
function help.command(description, commands, command)
assert(type(description) == "string")
assert(type(commands) == "table")
if not command then
print_banner()
print_section("NAME")
util.printout("\t"..program..[[ - ]]..description)
print_section("SYNOPSIS")
util.printout("\t"..program..[[ [<flags...>] [VAR=VALUE]... <command> [<argument>] ]])
print_section("GENERAL OPTIONS")
util.printout([[
These apply to all commands, as appropriate:
--dev Enable the sub-repositories in rocks servers
for rockspecs of in-development versions
--server=<server> Fetch rocks/rockspecs from this server
(takes priority over config file)
--only-server=<server> Fetch rocks/rockspecs from this server only
(overrides any entries in the config file)
--only-sources=<url> Restrict downloads to paths matching the
given URL.
--lua-dir=<prefix> Which Lua installation to use.
--lua-version=<ver> Which Lua version to use.
--tree=<tree> Which tree to operate on.
--local Use the tree in the user's home directory.
To enable it, see ']]..program..[[ help path'.
--global Use the system tree when `local_by_default` is `true`.
--verbose Display verbose output of commands executed.
--timeout=<seconds> Timeout on network operations, in seconds.
0 means no timeout (wait forever).
Default is ]]..tostring(cfg.connection_timeout)..[[.]])
print_section("VARIABLES")
util.printout([[
Variables from the "variables" table of the configuration file
can be overridden with VAR=VALUE assignments.]])
print_section("COMMANDS")
for name, modname in util.sortedpairs(commands) do
local cmd = require(modname)
util.printout("", name)
util.printout("\t", cmd.help_summary)
end
print_section("CONFIGURATION")
util.printout("\tLua version: " .. cfg.lua_version)
if cfg.luajit_version then
util.printout("\tLuaJIT version: " .. cfg.luajit_version)
end
util.printout()
util.printout("\tConfiguration files:")
local conf = cfg.config_files
util.printout("\t\tSystem : ".. dir.normalize(conf.system.file) .. " (" .. get_status(conf.system.found) ..")")
if conf.user.file then
util.printout("\t\tUser : ".. dir.normalize(conf.user.file) .. " (" .. get_status(conf.user.found) ..")")
else
util.printout("\t\tUser : disabled in this LuaRocks installation.")
end
if conf.project then
util.printout("\t\tProject : ".. dir.normalize(conf.project.file) .. " (" .. get_status(conf.project.found) ..")")
end
util.printout()
util.printout("\tRocks trees in use: ")
for _, tree in ipairs(cfg.rocks_trees) do
if type(tree) == "string" then
util.printout("\t\t"..dir.normalize(tree))
else
local name = tree.name and " (\""..tree.name.."\")" or ""
util.printout("\t\t"..dir.normalize(tree.root)..name)
end
end
util.printout()
else
command = command:gsub("-", "_")
local cmd = commands[command] and require(commands[command])
if cmd then
local arguments = cmd.help_arguments or "<argument>"
print_banner()
print_section("NAME")
util.printout("\t"..program.." "..command.." - "..cmd.help_summary)
print_section("SYNOPSIS")
util.printout("\t"..program.." "..command.." "..arguments)
print_section("DESCRIPTION")
util.printout("",(cmd.help:gsub("\n","\n\t"):gsub("\n\t$","")))
print_section("SEE ALSO")
if cmd.help_see_also then
util.printout(cmd.help_see_also)
end
util.printout("","'"..program.." help' for general options and configuration.\n")
else
return nil, "Unknown command: "..command
end
end
return true
end
return help
|