Method: CommandKit::Help::Man::ClassMethods#man_page

Defined in:
lib/command_kit/help/man.rb

#man_page(new_man_page = nil) ⇒ String

Gets or sets the class'es man-page file name.

Parameters:

  • new_man_page (String, nil) (defaults to: nil) —

    If a String is given, the class'es man-page file name will be set.

Returns:

  • (String) —

    The class'es or superclass'es man-page file name.

[View source]

92
93
94
95
96
97
98
 
# File 'lib/command_kit/help/man.rb', line 92

def man_page(new_man_page=nil)
  if new_man_page
    @man_page = new_man_page
  else
    @man_page || "#{command_name}.1"
  end
end