module CommandKit::Man

Allows displaying man pages.

## Examples

man "passwd"
man "passwd", section: 5

@since 0.2.0

Public Instance Methods

man(page, section: nil) click to toggle source

Displays the given man page.

@param [String] page

The man page file name.

@param [Integer, String, nil] section

The optional section number to specify.

@return [Boolean, nil]

Specifies whether the `man` command was successful or not.
Returns `nil` when the `man` command is not installed.

@example

man "passwd"

@example Display a man-page from a specific section:

man "passwd", section: 5

@api public

# File lib/command_kit/man.rb, line 36
def man(page, section: nil)
  if section
    system('man',section.to_s,page.to_s)
  else
    system('man',page.to_s)
  end
end