FilesExpand file tree

 master

/

help.lua

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

70 lines (59 loc) · 2.28 KB

 master

/

help.lua

Copy path

Top

File metadata and controls

• Code
• Blame

70 lines (59 loc) · 2.28 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

--- 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.

module("luarocks.help", package.seeall)

local util = require("luarocks.util")

local cfg = require("luarocks.cfg")

help_summary = "Help on commands."

help_arguments = "[<command>]"

help = [[

<command> is the command to show help for.

]]

--- 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 run(...)

local flags, command = util.parse_flags(...)

if not command then

print([[

LuaRocks ]]..cfg.program_version..[[, a module deployment system for Lua

]]..program_name..[[ - ]]..program_description..[[

usage: ]]..program_name..[[ [--from=<server> | --only-from=<server>] [--to=<tree>] [VAR=VALUE]... <command> [<argument>]

Variables from the "variables" table of the configuration file

can be overriden with VAR=VALUE assignments.

--from=<server> Fetch rocks/rockspecs from this server

(takes priority over config file)

--only-from=<server> Fetch rocks/rockspecs from this server only

(overrides any entries in the config file)

--to=<tree> Which tree to operate on.

Supported commands:

]])

local names = {}

for name, command in pairs(commands) do

table.insert(names, name)

end

table.sort(names)

for _, name in ipairs(names) do

local command = commands[name]

print(name, command.help_summary)

end

else

command = command:gsub("-", "_")

if commands[command] then

local arguments = commands[command].help_arguments or "<argument>"

print()

print(program_name.." "..command.." "..arguments)

print()

print(command.." - "..commands[command].help_summary)

print()

print(commands[command].help)

else

return nil, "Unknown command '"..command.."'"

end

end

return true

end