Contents

#
#--
# Ronin - A Ruby platform designed for information security and data
# exploration tasks.
#
# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#++
#

require 'ronin/ui/command_line/command'

module Ronin
  module UI
    module CommandLine
      class HelpCommand < Command

        command :help

        def define_options(opts)
          opts.usage = '[COMMAND]'

          opts.arguments(
            'COMMAND' => 'The command to view'
          )

          opts.summary('View a list of supported commands or information on a specific command')
        end

        def arguments(*args)
          if args.length > 1
            fail('only one command maybe specified')
          end

          topic = args.first

          if topic
            begin
              CommandLine.get_command(topic).help
            rescue UnknownCommand => exp
              CommandLine.fail(exp)
            end
          else
            puts 'Available commands:'

            CommandLine.commands.sort_by { |cmd|
              cmd.command_names.first
            }.each { |cmd|
              puts "  #{cmd.command_names.join(', ')}"
            }
          end
        end

      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ronin-0.1.4	lib/ronin/ui/command_line/commands/help.rb
ronin-0.1.3	lib/ronin/ui/command_line/commands/help.rb
ronin-0.2.0	lib/ronin/ui/command_line/commands/help.rb