Prev Up Next
Chapter 2. Installation  /  Installation Instructions

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 a Java Runtime Environment (JRE) is installed. If you have downloaded an installation package that contains the JRE, please note that the package will automatically install a JRE prior to execution of the application but this JRE will be used on your computer only for running <oXygen/> , it will be invisible to other applications.

[Note]Note

The installation kits and the executable files packaged inside the installation kits were checked before publication with an antivirus program to make sure they are not infected with viruses, trojan horses or other malicious software.

Procedure 2.1. Windows Installation

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

  2. Follow the instructions presented in the installation program. The user preferences are stored in the subfolder com.oxygenxml of the folder that is the value of the APPDATA Windows variable for the user that starts the application.

    [Note]Note

    In order to specify another Java virtual machine to be used by <oXygen/> you have to set the home folder of the desired JVM in the Windows variable JAVA_HOME or in the Windows variable JDK_HOME. If JAVA_HOME and JDK_HOME are not set the application launcher will try to detect a JVM installed in a standard location on the computer and use it for running the application. If you installed the kit which includes a Java virtual machine you have to rename of remove the jre subfolder of the install folder in order for the variable JAVA_HOME or JDK_HOME to have an effect.

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 version number of the application. The directory structure looks as follows: /../oxygen/9.3/

  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

    [Note]Note

    <oXygen/> uses the first JVM from the list of preferred JVM versions set on your Mac computer that has the version number not less than 1.5.0. To change the version of the Java virtual machine that runs the application you must move your desired JVM version up in the preferred list by dragging it with the mouse on the first position in the list of JVMs available from Applications -> Utilities -> Java -> Java Preferences.

Procedure 2.3. Linux Installation

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

  2. Follow the instructions presented in the installation program.

    [Note]Note

    In order to specify another Java virtual machine to be used by <oXygen/> you have to set the home folder of the desired JVM in the environment variable JAVA_HOME or in the environment variable JDK_HOME. If JAVA_HOME and JDK_HOME are not set the application launcher will try to detect a JVM installed in a standard location on the computer and use it for running the application.

Procedure 2.4. 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 application version number. The directory structure looks as follows: /../oxygen/9.3/

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

  4. Extract the archive to the same folder.

  5. Run from a command line the script oxygen.bat on Windows, oxygenMac.sh on Mac OS X, oxygen.sh on Unix/Linux.

    [Note]Note

    To change the version of the Java virtual machine that runs the application you have to specify the full path to the java executable of the desired JVM version in the Java command at the end of the script file, for example: 

    "C:\Program Files\Java\jre1.5.0_13\bin\java" -Xmx256m 
 -Dsun.java2d.noddraw=true ...

    on Windows, 

    /System/Library/Frameworks/JavaVM.framework/Versions/
1.5.0/Home/bin/java "-Xdock:name=Oxygen" ...

    on Mac OS X.

Procedure 2.5. Windows NT Terminal Server

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

  2. Edit the oxygen.vmoptions file located in the install folder, adding the parameter -Dcom.oxygenxml.MultipleInstances=true so that the file content looks like: -Xmx256m -Dcom.oxygenxml.MultipleInstances=true The "Xmx" value represents the maximum memory for each application 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.6. 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. Create a file called oxygen.vmoptions in the <oXygen/> install folder where the oxygen9.3 file is located. The content of the file must be: 

    -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 application by typing oxygen.sh

Unattended installation

Unattended installation is possible only on Windows and Linux by running the installer executable from command line and passing the -q parameter. The installer executable is called oxygen.exe on Windows and oxygen.sh on Linux

In unattended mode the installer does not overwrite files with the same name if a previous version of the application is installed in the same folder. The -overwrite parameter added after -q forces overwriting these files.

If the installer is executed in silent (unattended) mode and -console is passed as a second parameter after -q a console will be allocated on Windows that displays the output of the installer. The command for running the installer is in this case: 

start /wait oxygen.exe  -q -console

By default an unattended installation applies the default settings of the installer. If you want to install the application on a large number of computers but you need to change the default values of some settings (like the install folder on disk, whether a desktop icon or a quick launch shortcut are created, the file associations created in the operating system, the name of the program group on the Start menu, etc.) then you should use a special settings file which specifies the new values for these settings. To generate the settings file you have to run the installer in normal attended mode once on a test computer and specify the exact options that you want for the unattended installation. When the installation is completed a file called response.varfile and containing your selected options is created in the .install4j subfolder of the installation folder, by default C:\Program Files\Oxygen XML Editor 9\.install4j on Windows. This is a one time process. After that for applying these options on all the computers where an unattended installation is performed you have to specify this file in the command line, for example copy the file in the same location as the installer program and use the command:

- on Windows:

oxygen.exe -q -varfile response.varfile

- on Linux:

oxygen.sh  -q -varfile response.varfile


Prev Up Next
© 2008 syncRO soft ltd.