| 3 | | = Required sofware = |
| | 3 | ... |
| | 4 | |
| | 5 | == Required sofware == |
| | 6 | |
| | 7 | The following list contains all requierements for RefactorErl that are used by one or more features. If a listed program depends on further ones, then they are not listed but we suppos that they are installed with the standard (default) way. |
| | 8 | |
| | 9 | === Base system === |
| | 10 | |
| | 11 | * Erlang R14B04 or higher (currently WebInterface does ''not'' work with any higher version) |
| | 12 | * GCC 4.2 or higher |
| | 13 | * graphviz (TODO) (graph drawing, dependency visualization) |
| | 14 | * |
| | 15 | |
| | 16 | |
| | 17 | === WebInterface === |
| | 18 | * Yaws 1.89 |
| | 19 | * Web browser (Mozilla Firefox 3.6 or higher, Google Chrome) |
| | 20 | |
| | 21 | === EmacsInterface === |
| | 22 | |
| | 23 | * Emacs 23.3 or higher with erlang-mode and widget |
| | 24 | |
| | 25 | === EclipseInterface === |
| | 26 | |
| | 27 | * Eclipse (TODO) |
| | 28 | |
| | 29 | === VimInterface === |
| | 30 | |
| | 31 | * Vim 7.2 or higher |
| | 32 | |
| | 33 | ... |
| | 34 | |
| | 35 | == Local install instructions on Linux == |
| | 36 | |
| | 37 | You can install RefactorErl on a system where you have no admin |
| | 38 | right. Follow the instructions below. |
| | 39 | |
| | 40 | You need some packages installed by the admin, but they can be found |
| | 41 | in almost all Linux system. These are: |
| | 42 | * gcc >= 4.5 |
| | 43 | * make |
| | 44 | * tar |
| | 45 | * bash |
| | 46 | * openssl (for yaws) |
| | 47 | * ncurses |
| | 48 | * (optional) wx |
| | 49 | |
| | 50 | I will assume that you would like to install the tool into a local |
| | 51 | "root" directory. You should modify the next route to your one: |
| | 52 | E.g.: /home/olikas/local |
| | 53 | |
| | 54 | {{{ |
| | 55 | export REFERL_ROOT=/path/to/localroot |
| | 56 | }}} |
| | 57 | |
| | 58 | The local "ghost" user will be 'referl' by default. Feel free to |
| | 59 | modify it. |
| | 60 | |
| | 61 | {{{ |
| | 62 | export REFERL_GHOST_USER=referl |
| | 63 | }}} |
| | 64 | |
| | 65 | Run the next script to initialize the directory layout. |
| | 66 | |
| | 67 | {{{ |
| | 68 | cd ~ |
| | 69 | mkdir $REFERL_ROOT |
| | 70 | cd $REFERL_ROOT |
| | 71 | mkdir home |
| | 72 | cd home |
| | 73 | mkdir $REFERL_GHOST_USER |
| | 74 | }}} |
| | 75 | |
| | 76 | To install Erlang |
| | 77 | |
| | 78 | {{{ |
| | 79 | cd $REFERL_ROOT/$REFERL_GHOST_USER |
| | 80 | wget www.erlang.org/download/otp_src_R14B04.tar.gz |
| | 81 | tar xvvf otp_src_R14B04.tar.gz |
| | 82 | cd otp_src_R14B04 |
| | 83 | ./configure --prefix=$REFERL_ROOT |
| | 84 | make |
| | 85 | make install |
| | 86 | cd .. |
| | 87 | rm otp_src_R14B04.tar.gz |
| | 88 | }}} |
| | 89 | |
| | 90 | To install RefactorErl: |
| | 91 | |
| | 92 | {{{ |
| | 93 | cd $REFERL_ROOT/$REFERL_GHOST_USER |
| | 94 | wget http://plc.inf.elte.hu/erlang/dl/refactorerl-0.9.12.01.tar.gz |
| | 95 | tar xvvf refactorerl-0.9.12.01.tar.gz |
| | 96 | cd refactorerl-0.9.12.01 |
| | 97 | bin/referl -erl $REFERL_ROOT/bin/erl -build tool |
| | 98 | cd .. |
| | 99 | rm refactorerl-0.9.12.01.tar.gz |
| | 100 | }}} |
| | 101 | |
| | 102 | Now you can start the tool: |
| | 103 | |
| | 104 | {{{ |
| | 105 | cd $REFERL_ROOT/$REFERL_GHOST_USER/refactorerl-.9.12.01 |
| | 106 | bin/referl -erl $REFERL_ROOT/bin/erl |
| | 107 | }}} |
| | 108 | |
| | 109 | If you want to use the web based interface of the tool you have to |
| | 110 | install the proper version (1.89) of Yaws. |
| | 111 | |
| | 112 | {{{ |
| | 113 | cd $REFERL_ROOT/$REFERL_GHOST_USER |
| | 114 | wget http://yaws.hyber.org/download/yaws-1.89.tar.gz |
| | 115 | tar xvvf yaws-1.89.tar.gz |
| | 116 | cd yaws |
| | 117 | export ERL=$REFERL_ROOT/bin/erl |
| | 118 | export ERLC=$REFERL_ROOT/bin/erlc |
| | 119 | ./configure --prefix=$REFERL_ROOT --localstatedir=$REFERL_ROOT/var --sysconfdir=$REFERL_ROOT/etc |
| | 120 | make |
| | 121 | make install |
| | 122 | cd .. |
| | 123 | rm yaws-1.89.tar.gz |
| | 124 | }}} |
| | 125 | |
| | 126 | To run the tool execute the following commands. Remember to substitute |
| | 127 | your path to 'yaws_path' part. Do not forget to change the path to yours. |
| | 128 | |
| | 129 | {{{ |
| | 130 | cd $REFERL_ROOT/$REFERL_GHOST_USER/refactorerl-.9.12.01 |
| | 131 | bin/referl -erl $REFERL_ROOT/bin/erl -db nif |
| | 132 | }}} |
| | 133 | |
| | 134 | {{{ |
| | 135 | ri:start_nitrogen([{yaws_path, "/path/to/localroot/lib/yaws/ebin/"}]). |
| | 136 | }}} |