= Step-by-step tutorial: local install instructions on Linux

You can install !RefactorErl on a system where you do not own admin rights. Follow the instructions below.

You need some packages to be installed by the admin, but they likely can be found on almost all Linux systems. These are:
 * gcc (>= 4.5)
 * make
 * tar
 * bash
 * m4
 * ncurses

 * libpam-dev (for yaws on Debian)
 * pam-devel (for yaws on Fedora)
 * openssl (for yaws)
 * wx (optional)

We assume you would like to install the tool into a local root (e.g. /home/user/local). Modify the following path to your one:

{{{#!sh
export REFERL_ROOT=/path/to/localroot
}}}

The local "ghost" user will be 'referl' by default. Feel free to modify it.

{{{#!sh
export REFERL_GHOST_USER=referl
}}}

Run the next command in order to initialize the directory layout.

{{{#!sh
mkdir -p $REFERL_ROOT/home/$REFERL_GHOST_USER
}}}

If you have not installed Erlang yet, run the following commands to install Erlang/OTP R14B04:

{{{#!sh
cd $REFERL_ROOT/home/$REFERL_GHOST_USER
wget www.erlang.org/download/otp_src_R14B04.tar.gz
tar xvvf otp_src_R14B04.tar.gz
cd otp_src_R14B04
./configure --prefix=$REFERL_ROOT
make
make install
cd ..
rm otp_src_R14B04.tar.gz
}}}

To install !RefactorErl:

{{{#!sh
cd $REFERL_ROOT/home/$REFERL_GHOST_USER
wget http://plc.inf.elte.hu/erlang/dl/refactorerl-0.9.13.02.tar.gz
tar xvvf refactorerl-0.9.13.02.tar.gz
cd refactorerl-0.9.13.02
bin/referl -erl $REFERL_ROOT/bin/erl -build tool
cd ..
rm refactorerl-0.9.13.02.tar.gz
}}}

Now you should be able to use your !RefactorErl installation. If you would like to use the web based interface of the tool, you have to install the version 1.90 or higher versions of Yaws. The suggested version is 1.92.

If the version 1.89 of Yaws is needed to be used, then you should re-build the tool as described below:
{{{#!sh
cd $REFERL_ROOT/home/$REFERL_GHOST_USER
cd refactorerl-0.9.13.02
bin/referl -erl $REFERL_ROOT/bin/erl -build tool -yaws_189
}}}

If one of the higher version of Yaws is going to be used, you needn't do anything.

To install Yaws:
{{{#!sh
cd $REFERL_ROOT/home/$REFERL_GHOST_USER
wget http://yaws.hyber.org/download/yaws-1.92.tar.gz
tar xvvf yaws-1.92.tar.gz
cd yaws
export ERL=$REFERL_ROOT/bin/erl
export ERLC=$REFERL_ROOT/bin/erlc
./configure --prefix=$REFERL_ROOT --localstatedir=$REFERL_ROOT/var --sysconfdir=$REFERL_ROOT/etc
make
make install
cd ..
rm yaws-1.92.tar.gz
}}}

To run the tool, execute the following commands:

{{{#!sh
cd $REFERL_ROOT/home/$REFERL_GHOST_USER/refactorerl-0.9.13.02
bin/referl -erl $REFERL_ROOT/bin/erl -db nif
}}}

If you have successfully installed Yaws, you can start the nitrogen-based web UI with the following function call (mind to change the 'yaws_path'):

{{{#!erlang
ri:start_nitrogen([{yaws_path, "/path/to/localroot/lib/yaws/ebin/"}]).
}}}