Class: Factorix::CLI::Commands::Man

Inherits:

Base

• Object
• Dry::CLI::Command
• Base
• Factorix::CLI::Commands::Man

Defined in:

lib/factorix/cli/commands/man.rb

Overview

Display the Factorix manual page

This command opens the man page for factorix using the system’s man command.

Examples:

$ factorix man

Instance Method Summary

• #call ⇒ void

  Execute the man command.

Methods inherited from Base

backup_support!, confirmable!, inherited, require_game_stopped!

Instance Method Details

#call ⇒ void

This method returns an undefined value.

Execute the man command

Raises:

• (CommandNotFoundError) —

  if man command is not available

# File 'lib/factorix/cli/commands/man.rb', line 19

def call(**)
  system("command -v man > /dev/null 2>&1")
  raise CommandNotFoundError, "man command is not available on this system" unless $?.success?

  man_page = File.expand_path("../../../../doc/factorix.1", __dir__)
  exec "man", man_page
end