<oXygen/> XML Editor User Guide

Installation Instructions

Prior to proceeding with the following instructions, please ensure that your system complies with the prerequisites detailed in the installation requirements.

[Note]Note

The following instructions assume that JRE is installed. If you have downloaded an installation package that contains the JRE, please note that the package will automatically install Java prior to execution of the application.

Procedure 2.1. Windows Installation

[Warning]Warning

Do not install the application in the same folder where you have downloaded the oxygen.exe installer as this conflicts with the application name.

  1. Download the oxygen.exe installation kit and run it.

  2. Follow the instructions presented in the installation program.

    [Note]Note

    In order to specify another Virtual Machine to be used by oXygen, edit the oxygen.ini file from the installation directory. In the [Java Runtime Environment] section add the following entry:

    JRE Path = <path_to_jre>

    where <path_to_jre> is the path to the installed JRE of your choice.

Procedure 2.2. Mac OS X Installation

  1. Create a folder called oxygen on your local disk.

  2. Within the oxygen folder, create child folder named in accordance with the <oXygen/> version number. The directory structure looks as follows: /../oxygen/6.0/

  3. Download the Mac OS X Installation package (oxygen.tar.gz) to this folder.

  4. Extract the archive to the same folder.

  5. Execute the file named oxygen

Procedure 2.3. All Platforms Installation

  1. Create a folder called oxygen on your local disk.

  2. Within the oxygen folder, create child folder named in accordance with the <oXygen/> version number. The directory structure looks as follows: /../oxygen/6.0/

  3. Download the All Platforms Installation package (oxygen.tar.gz) to this folder.

  4. Extract the archive to the same folder.

  5. On Windows execute oxygen.bat, for Mac execute oxygenMac.sh, and for Unix execute oxygen.sh.

Procedure 2.4. Windows NT Terminal Server

  1. Install the editor on the server, making its shortcuts available to all users.

  2. Edit the oxygen6.1.ini file located in the install folder, changing the parameter "Virtual Machine Parameters" to Virtual Machine Parameters = -Xmx256m -Dcom.oxygenxml.MultipleInstances=true The "Xmx" value represents the maximum memory for each editor instance. Please make sure you tune them in a way that the multiple editor instances won't use all the available physical memory.

Procedure 2.5. Unix Server

  1. Install the editor on the server, making sure the oxygen.sh script is executable and the installation directory is in the PATH of the users that need to use the editor.

  2. Edit the oxygen.lax file located in the install folder, changing the parameter "lax.nl.java.option.additional" to lax.nl.java.option.additional = -Xmx256m -Dcom.oxygenxml.MultipleInstances=true The "Xmx" value represents the maximum memory for each editor instance. Please make sure you tune it in a way that the multiple editor instances won't use all the available physical memory.

  3. Make sure the X server processes located on the workstations allow connections from the server host. For this use the xhost command.

  4. Telnet (or ssh) on the server host.

  5. Start an xterm process, with display on the workstation. Ex: xterm -display workstationip:0.0

  6. Start the editor by typing oxygen.sh