refe(1)

NAME

refe - Ruby reference manual referer

SYNOPSIS

refe [-als] [-d dir] [[-r] class | method] [-e function] [-C function] [-c method]

DESCRIPTIONS

ReFe lookups reference manual entry and print it. One of the class name, method name, function name is allowd.

Class/Method Name Expressions (-r/-c)

class
    Produces the list of all methods of the class

class#method | class, method | class method | method
    Produces method description.

Function Name Expressions (-e/-C)

_w  Expanded to "rb_". e.g. _eval -> rb_eval

w_w_w
    Expanded to word_word_word. e.g. r_e_s_w -> rb_eval_string_wrap

w w w
    Expanded to word_word_word. e.g. r e s w -> rb_eval_string_wrap

OPTIONS

-r  Lookup method document from method name.

-c  Lookup function from method name.

-e  Lookup function document from function name.

-C  Lookup function from function name.

-a, --all
    Print all description of classes/methods.

-s, --short
    Print only names.

-l, --line
    Print one name per one line.

-d dir, --databasedir=dir
    Use dir as the database root directory.

--version
    Print command version and quit.

--copyright
    Print copyright and quit.

-h, --help
    Print help message and quit.

EXAMPLES 1 - Lookup Class Reference Manual Entry
% refe s gsub #=> String#gsub % refe 'i#see' #=> IO#seek % refe s,ind #=> String#index % refe each_w #=> Enum#each_with_index

EXAMPLES 2 - Lookup Extention API Reference Manual Entry
% refe -e data wrap #=> Data_Wrap_Struct() % refe -e _str dup #=> rb_str_dup()

EXAMPLES 3 - Lookup Function Source
% refe -C r e s w #=> rb_eval_sring_wrap() % refe -C _str strip #=> rb_str_strip() % refe -c Array join #=> rb_array_join_m()

SEE ALSO
ruby(1), rd2(1)

COPYRIGHT
Copyright (C) 2001-2003 Minero Aoki