| | 2 | |
| | 3 | The RefactorErl tool can be started a standalone or as an embedded application. |
| | 4 | |
| | 5 | === Standalone application === |
| | 6 | |
| | 7 | To start the tool run from the base directory of RefactorErl |
| | 8 | |
| | 9 | {{{ |
| | 10 | bin/referl |
| | 11 | }}} |
| | 12 | |
| | 13 | under Linux or |
| | 14 | |
| | 15 | {{{ |
| | 16 | bin/referl.bat |
| | 17 | }}} |
| | 18 | |
| | 19 | under Windows. |
| | 20 | Note that the tool starts with the MNESIA database backend by default, |
| | 21 | and if you want to use NIF, then you have to start the tool like this: |
| | 22 | |
| | 23 | {{{ |
| | 24 | bin/referl -db nif |
| | 25 | }}} |
| | 26 | |
| | 27 | For further parameters use {{{-help}}}: |
| | 28 | |
| | 29 | || -base PATH || Path to the RefactorErl base directory || |
| | 30 | || -browser\_root || Set the file browser root directory || |
| | 31 | || -build TARGET || Build TARGET (e.g. tool, doc, clean) || |
| | 32 | || -client || Start in client mode (no server is started) || |
| | 33 | || -db [mnesia|nif] || The database engine to use (default: mnesia) || |
| | 34 | || -dir DIR || Sets the RefactorErl data directory || |
| | 35 | || -emacs || Start as an Emacs client || |
| | 36 | || -erl PATH || Path to the Erlang executable to use || |
| | 37 | || -g++ PATH || Path of the g++ compiler to use || |
| | 38 | || -help || Print this help text || |
| | 39 | || -images\_dir || Set root directory where generated Nitrogen images will be written || |
| | 40 | || -name NAME || Full name of the Erlang node || |
| | 41 | || -nitrogen || Start with Nitrogen || |
| | 42 | || -no\_nif || NIF code will not be compiled (use with '-build tool') || |
| | 43 | || -server || Start in server mode (no shell is started) || |
| | 44 | || -sname NAME || Short name of the Erlang node || |
| | 45 | || -srvname NAME || Name of the Erlang server node to connect || |
| | 46 | || -yaws || Start with yaws web server || |
| | 47 | || -yaws\_listen IP || Set yaws IP || |
| | 48 | || -yaws\_name NAME || Set yaws server name || |
| | 49 | || -yaws\_path PATH || Path to the Yaws ebin directory (need /ebin at the end) || |
| | 50 | || -yaws\_port PORT || Set yaws port || |
| | 51 | |
| | 52 | === Embedded application === |
| | 53 | |
| | 54 | User interfaces like emacs or eclipse are capable of starting RefactorErl through their GUI. Fur further information visit EmacsInterface, EclipseInterface, etc. |
