module Hirb

Most of Hirb's functionality is in Hirb::View. For a tutorial on configuring and creating views see Hirb::View. For a tutorial on dynamic views see Hirb::DynamicView.

Config Files

Hirb can have multiple config files defined by ::config_files(). These config files have the following top level keys:

:output: This hash is used by the formatter object. See Hirb::Formatter#config for its format.
:width: Width of the terminal/console. Defaults to Hirb::View::DEFAULT_WIDTH or possibly autodetected when Hirb is enabled.
:height: Height of the terminal/console. Defaults to Hirb::View::DEFAULT_HEIGHT or possibly autodetected when Hirb is enabled.
:formatter: Boolean which determines if the formatter is enabled. Defaults to true.
:pager: Boolean which determines if the pager is enabled. Defaults to true.
:pager_command: Command to be used for paging. Command can have options after it i.e. 'less -r'. Defaults to common pagers i.e. less and more if detected.
:ignore_errors: Boolean which ignores internal view errors and continues with original view (i.e. inspect for irb). Defaults to false.

Constants

VERSION

Attributes

config[RW]

config_files[RW]

Public Class Methods

add_dynamic_view(view, options, &block) click to toggle source

Adds views. See Hirb::DynamicView.add for details.

# File lib/hirb.rb, line 52
def add_dynamic_view(view, options, &block)
  DynamicView.add(view, options, &block)
end

add_view(view, options, &block) click to toggle source

Adds views. See Hirb::View.add for details.

# File lib/hirb.rb, line 47
def add_view(view, options, &block)
  View.add(view, options, &block)
end

disable() click to toggle source

Disables view functionality. See Hirb::View.disable for details.

# File lib/hirb.rb, line 42
def disable
  View.disable
end

enable(options={}, &block) click to toggle source

Enables view functionality. See Hirb::View.enable for details.

# File lib/hirb.rb, line 37
def enable(options={}, &block)
  View.enable(options, &block)
end