Changes between Version 3 and Version 4 of StartUp
- Timestamp:
- Apr 18, 2012, 9:21:13 AM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
StartUp
v3 v4 1 = = Starting the tool ==1 = Starting the tool 2 2 3 The RefactorErl tool can be starteda standalone or as an embedded application.3 !RefactorErl can be started either as a standalone or as an embedded application. 4 4 5 == = Standalone application ===5 == Standalone application 6 6 7 ==== Normal mode ====7 ==== Normal mode 8 8 9 To start the tool run from the base directory of RefactorErl9 To start the tool, simply execute our startup script from the base directory of your !RefactorErl copy: 10 10 11 {{{ 11 (In Linux) 12 {{{ 12 13 bin/referl 13 14 }}} 14 15 15 under Linux or 16 16 (In Windows) 17 17 {{{ 18 18 bin/referl.bat 19 19 }}} 20 20 21 under Windows. 22 Note that the tool starts with the MNESIA database backend by default, 23 and if you want to use NIF, then you have to start the tool like this: 21 Note that if you do not specify the back-end to be used, the tool uses the [wiki:MnesiaDB mnesia-based database] by default. If you would like to use another back-end, for example, the [wiki:MnesiaDB NIF-based C++ graph], you should start the tool like this: 24 22 25 23 {{{ … … 27 25 }}} 28 26 29 For further parameters use {{{-help}}}: 27 ==== Options 30 28 31 || -base PATH || Path to the RefactorErl base directory || 32 || -browser\_root || Set the file browser root directory || 29 The following table details the possible startup options. You can get this list any time by using the {{{-help}}} option. 30 31 || -base PATH || Path to the !RefactorErl base directory || 32 || -browser_root || Set the file browser root directory || 33 33 || -build TARGET || Build TARGET (e.g. tool, doc, clean) || 34 34 || -client || Start in client mode (no server is started) || 35 35 || -db [mnesia|nif] || The database engine to use (default: mnesia) || 36 || -dir DIR || Sets the RefactorErl data directory||36 || -dir DIR || Sets the !RefactorErl data directory || 37 37 || -emacs || Start as an Emacs client || 38 38 || -erl PATH || Path to the Erlang executable to use || 39 39 || -g++ PATH || Path of the g++ compiler to use || 40 40 || -help || Print this help text || 41 || -images \_dir|| Set root directory where generated Nitrogen images will be written ||41 || -images_dir || Set root directory where generated Nitrogen images will be written || 42 42 || -name NAME || Full name of the Erlang node || 43 43 || -nitrogen || Start with Nitrogen || 44 || -no \_nif || NIF code will not be compiled (use with '-build tool')||44 || -no_nif || NIF code will not be compiled (use with ''-build tool'') || 45 45 || -server || Start in server mode (no shell is started) || 46 46 || -sname NAME || Short name of the Erlang node || 47 47 || -srvname NAME || Name of the Erlang server node to connect || 48 48 || -yaws || Start with yaws web server || 49 || -yaws \_listen IP|| Set yaws IP ||50 || -yaws \_name NAME|| Set yaws server name ||51 || -yaws \_path PATH|| Path to the Yaws ebin directory (need /ebin at the end) ||52 || -yaws \_port PORT|| Set yaws port ||49 || -yaws_listen IP || Set yaws IP || 50 || -yaws_name NAME || Set yaws server name || 51 || -yaws_path PATH || Path to the Yaws ebin directory (need /ebin at the end) || 52 || -yaws_port PORT || Set yaws port || 53 53 54 ==== Server mode ====54 ==== Server mode 55 55 56 RefactorErl can be run as a server, you only have to specify a name with {{{-name}}} or {{{-sname}}} options to the command line. If you do not want to have a command line access to the server you can add the {{{-server}}} option the the starting command, but it is not necessary.56 !RefactorErl can be run as a server, you only have to specify a name with {{{-name}}} or {{{-sname}}} when starting the tool. If you do not need a command line access to the server, you can use the {{{-server}}} option, which starts the tool in server-only mode. 57 57 58 ==== Client mode ====58 ==== Client mode 59 59 60 If you have a running RefactorErl application (let's call it 'server') that was started with {{{-name}}} or {{{-sname}}}, then you can connect to this server with another command line client. In this case you can run Erlang commands that will run on the server. To start the client use the {{{-srvname}}} option with the exact name of the server. You you have used {{{-name}}} with the server, you have to use the same for the client. The same is true for {{{-sname}}} respectively.60 If you already have a running !RefactorErl instance (a running "server") started with {{{-name}}} or {{{-sname}}}, then you can connect to this server with a command line client and you can enter Erlang commands that will be executed on the server. To start a client, use the {{{-client}}} option and specify the name of the server (the name you have used in {{{-name}}} or {{{-sname}}} while starting the server) with the {{{-srvname}}} option. 61 61 62 === Embedded application ===62 === Embedded application 63 63 64 User interfaces like emacs or eclipse are capable of starting RefactorErl through their GUI. Fur further information visit EmacsInterface, EclipseInterface, etc.64 User interfaces like [EmacsInterface Emacs] and [EclipseInterface Eclipse] are capable of starting their embedded instance of !RefactorErl. For further information visit the pages of various interfaces.
