# ruby(9)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## SYNOPSIS

Ruby - Ruby programming language

## FILES

hkruby.emf - Ruby programming language file hook definition

## EXTENSIONS

.rb - Ruby programming language

## MAGIC STRINGS

#![ \t]*/.*ruby

MicroEmacs 2009 recognizes the magic string on any of the first line of the file.

-[*!]-[ \t]*ruby.*-[*!]-

GNU Emacs magic string.

The ruby files may be extension-less and are still recognized.

## DESCRIPTION

The ruby file type template provides simple highlighting of Ruby files.

General Editing

On creating a new file, a new header is automatically included into the file. time(2m) is by default enabled, allowing the modification time-stamp to be maintained in the header.

Highlighting

The highlighting features allow commands, variables, logical, preprocessor definitions, comments, strings and characters of the language to be differentiated and rendered in different colors.

Folding and Information Hiding

Generic folding is enabled, the folds occur about module and class definitions located on the left-hand margin. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

List Items

Item listing is available and the key constructs of the file may be listed in the item-list.

Indentation

Automatic indentation is provided, including a buffer re-style.

Short Cuts

The short cut keys used within the buffer are:-

esc h - Key binding help information.
C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with hash (#).
C-c C-o - Format a comment
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - List items.
esc f6 - Close list items window.

## BUGS

In line redirection (i.e. `<< EOL`) can cause rendering and indent anomalies.

The block documentation remains under indent control, this should be disabled.

## SEE ALSO

Supported File Types

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>