Ruby in a Nutshell

Name

Readline — GNU readline library interface

Synopsis

The Readline module provides a interface to the GNU line editing library named readline.

Required Library

require ‘readline’

Example

require 'readline'
include Readline
line = readline("Prompt> ", true)

Module Function

readline(prompt, add_history)

Reads one line with line editing. If the add is true, the line is also added to the history.

Module Methods

Readline::completion_proc=proc

Specifies Proc object to determine completion behavior. Takes input string, and returns completion candidates.

Readline::completion_proc

Returns the completion Proc object.

Readline::completion_case_fold=bool

Sets whether or not to ignore case on completion.

Readline::completion_case_fold

Returns true if completion ignores case.

Readline::completion_append_character=char

Specifies a character to be appended on completion. If empty string (“”) or nil is specified, nothing is appended.

Readline::completion_append_character

Returns a string containing a character to be appended on completion. Default is a space.

Readline::vi_editing_mode

Specifies vi editing mode.

Readline::emacs_editing_mode

Specifies Emacs editing mode.

Constant

HISTORY

The history buffer; it behaves just like an array.