== Starting the tool == 

The RefactorErl tool can be started a standalone or as an embedded application.

=== Standalone application ===

To start the tool run from the base directory of RefactorErl

{{{
bin/referl
}}}

under Linux or

{{{
bin/referl.bat
}}}

under Windows.
Note that the tool starts with the MNESIA database backend by default,
and if you want to use NIF, then you have to start the tool like this:

{{{
bin/referl -db nif
}}}

For further parameters use {{{-help}}}:

|| -base PATH          || Path to the RefactorErl base directory                                 ||
|| -browser\_root      || Set the file browser root directory                                    ||
|| -build TARGET       || Build TARGET (e.g. tool, doc, clean)                                   ||
|| -client             || Start in client mode (no server is started)                            ||
|| -db [mnesia|nif]    || The database engine to use (default: mnesia)                           ||
|| -dir DIR            || Sets the RefactorErl data directory                                    ||
|| -emacs              || Start as an Emacs client                                               ||
|| -erl PATH           || Path to the Erlang executable to use                                   ||
|| -g++ PATH           || Path of the g++ compiler to use                                        ||
|| -help               || Print this help text                                                   ||
|| -images\_dir        || Set root directory where generated Nitrogen images will be written     ||
|| -name NAME          || Full name of the Erlang node                                           ||
|| -nitrogen           || Start with Nitrogen                                                    ||
|| -no\_nif            || NIF code will not be compiled (use with '-build tool')                 ||
|| -server             || Start in server mode (no shell is started)                             ||
|| -sname NAME         || Short name of the Erlang node                                          ||
|| -srvname NAME       || Name of the Erlang server node to connect                              ||
|| -yaws               || Start with yaws web server                                             ||
|| -yaws\_listen IP    || Set yaws IP                                                            ||
|| -yaws\_name NAME    || Set yaws server name                                                   ||
|| -yaws\_path PATH    || Path to the Yaws ebin directory (need /ebin at the end)                ||
|| -yaws\_port PORT    || Set yaws port                                                          ||

=== Embedded application ===

User interfaces like emacs or eclipse are capable of starting RefactorErl through their GUI. Fur further information visit EmacsInterface, EclipseInterface, etc.