Class: GLI::Commands::Help

Inherits:
GLI::Command show all
Defined in:
lib/gli/commands/help.rb

Overview

The help command used for the two-level interactive help system

Constant Summary collapse

@@skips_pre = 
true
@@skips_post = 
true
@@skips_around = 
true

Instance Attribute Summary

Attributes included from GLI::CommandSupport

#parent

Attributes inherited from GLI::CommandLineToken

#aliases, #description, #long_description, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GLI::Command

#action, #default_command, #default_desc, #has_option?, name_as_string

Methods included from GLI::CommandSupport

#arg_name, #arguments_description, #arguments_options, #commands, #commands_declaration_order, #context_description, #default_description, #default_value, #desc, #execute, #flag, #flags, #get_default_command, #has_action?, #long_desc, #names, #nodoc, #switch, #switches, #topmost_ancestor, #usage

Methods included from DSL

#arg_name, #clear_nexts, #command, #default_value, #desc, #flag, #flags_declaration_order, #long_desc, #switch, #switches_declaration_order

Methods included from GLI::CopyOptionsToAliases

#copy_options_to_aliases

Methods inherited from GLI::CommandLineToken

#<=>, #usage

Constructor Details

#initialize(app, output = $stdout, error = $stderr) ⇒ Help

Returns a new instance of Help.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/gli/commands/help.rb', line 47

def initialize(app,output=$stdout,error=$stderr)
  super(:names => :help,
        :description => 'Shows a list of commands or help for one command',
        :arguments_name => 'command',
        :long_desc => 'Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function')
  @app = app
  @sorter = SORTERS[@app.help_sort_type]
  @text_wrapping_class = WRAPPERS[@app.help_text_wrap_type]

  desc 'List commands one per line, to assist with shell completion'
  switch :c

  action do |global_options,options,arguments|
    show_help(global_options,options,arguments,output,error)
  end
end

Class Method Details

.skips_around=(skips_around) ⇒ Object

Configure help to explicitly skip or not skip the around block when the help command runs. This is here because the creation of the help command is outside of the client programmer’s control



45
 
# File 'lib/gli/commands/help.rb', line 45

def self.skips_around=(skips_around) ; @@skips_around = skips_around ; end

.skips_post=(skips_post) ⇒ Object

Configure help to explicitly skip or not skip the post block when the help command runs. This is here because the creation of the help command is outside of the client programmer’s control



42
 
# File 'lib/gli/commands/help.rb', line 42

def self.skips_post=(skips_post)     ; @@skips_post = skips_post     ; end

.skips_pre=(skips_pre) ⇒ Object

Configure help to explicitly skip or not skip the pre block when the help command runs. This is here because the creation of the help command is outside of the client programmer’s control



39
 
# File 'lib/gli/commands/help.rb', line 39

def self.skips_pre=(skips_pre)       ; @@skips_pre = skips_pre       ; end

Instance Method Details

#skips_around ⇒ Object 



66
 
# File 'lib/gli/commands/help.rb', line 66

def skips_around ; @@skips_around ; end

#skips_post ⇒ Object 



65
 
# File 'lib/gli/commands/help.rb', line 65

def skips_post   ; @@skips_post   ; end

#skips_pre ⇒ Object 



64
 
# File 'lib/gli/commands/help.rb', line 64

def skips_pre    ; @@skips_pre    ; end