In Files
Parent
- Object
Methods
Information
Help
Encpsulates help output with code to display well formated help output and manpages output.
Public Class Methods
Public Instance Methods
help_text()
click to toggle source
# File lib/executioner/help.rb, line 26
26: def help_text
27: commands = @cli_class.subcommands
28: descriptions = @cli_class.descriptions
29:
30: options = []
31:
32: descriptions.each do |meth, desc|
33: case meth
34: when /^(.*?)[\!\=]$/
35: options << [$1, meth]
36: end
37: end
38:
39: options = options.sort{ |a,b| a[0] <=> b[0] }
40:
41: s = ''
42: s << File.basename($0)
43:
44: s << "\n\n" + @cli_class.header
45:
46: if !commands.empty?
47: s << "\n\nCOMMANDS:\n\n"
48: commands.each do |cmd, klass|
49: s << " %-15s %s\n" % [cmd, klass.description]
50: end
51: end
52:
53: s << "\n\nOPTIONS:\n\n"
54: options.each do |(name, meth)|
55: if name.size == 1
56: s << " -%-15s %s\n" % [name, descriptions[meth]]
57: else
58: s << " --%-15s %s\n" % [name, descriptions[meth]]
59: end
60: end
61:
62: #s << "\nCOMMON OPTIONS:\n\n"
63: #global_options.each do |(name, meth)|
64: # if name.size == 1
65: # s << " -%-15s %s\n" % [name, descriptions[meth]]
66: # else
67: # s << " --%-15s %s\n" % [name, descriptions[meth]]
68: # end
69: #end
70:
71: s << "\n"
72: s << @cli_class.footer if @cli_class.footer
73: s << "\n"
74: s
75: end
Disabled; run with --debug to generate this.