Edit online

Setting a Java Virtual Machine Parameter when Launching Oxygen XML Editor

You can set Java Virtual Machine parameters (for example, if you want to increase the maximum amount of memory available) for the Oxygen XML Editor application launchers or command-line scripts. You can also create a custom startup parameters file.

Edit online

Setting Parameters for the Application Launchers

Increasing the Amount of Memory that Oxygen XML Editor Uses on Windows and Linux

For Windows and Linux installations of Oxygen XML Editor, the startup launchers for the application and its executable internal tools (Tree Editor, XML Schema Regular Expressions Builder, Large File Viewer, SVN Client, Compare Directories, and Compare Files) include a default .vmoptions file in the installation directory that contains some startup parameters (such the -Xmx parameter, which is used for allocating memory for that particular application). If your installation contains these .vmoptions files, you can edit the parameters in them so that the applications will launch with your desired values. However, if you re-install the application, install an update for the application, or deploy it to other users or machines, those parameters will be reset to their default values.

To increase the memory available to the Oxygen XML Editor application on Windows:
  1. Browse the installation directory of Oxygen XML Editor.
  2. Locate the -Xmx parameter in the oxygen24.1.vmoptions file. If it is located in a directory where you do not have write access, copy the file to another folder (where you do have write access), modify it there, and then copy it back to the original location.
    Note: The parameters from the .vmoptions file are used when you start Oxygen XML Editor with the oxygen launcher (or with the desktop shortcut). If you use the command-line script (<oxygen.bat> or <oxygen.sh>) to launch Oxygen XML Editor, modify the -Xmx parameter in that script file.
    Tip: For 32-bit Windows, modify the parameter to -Xmx1024m or larger, but not over -Xmx1200m. Make sure you do not exceed your physical RAM. For 64-bit Windows modify the parameter to a larger value (for example, -Xmx2048m). It is recommended to not use more than half of your existing physical RAM.
  3. Restart Oxygen XML Editor. Go to Help > About and verify the amount of memory that is actually available (see the JVM Memory Used in the last row in the Copyright tab). If Oxygen XML Editor does not start and you receive and error message saying that it could not start the JVM, decrease the -Xmx parameter and try again.

Increasing the Amount of Memory that Oxygen XML Editor Uses on macOS

To increase the memory available to Oxygen XML Editor on macOS:
  1. Ctrl + Single-Click (Command + Single-Click on macOS) (or right-click) the Oxygen XML Editor icon in Finder.
  2. From the contextual menu, select Show Package Contents.
  3. Go to the contents directory and edit the Info.plist file.
    Note: You can open this file either with the Property List Editor, or the TextEdit.
  4. Look for the VMOptionArray key and add the -Xmx parameter in a new <string> element from the <array> element. For example, for 1500 MB, use the following:
    <key>VMOptionArray</key>
    <array>
    <string>-Xmx1500m</string>
     ...
    </array>
    Tip: Try not to use more than half of your existing physical RAM if possible.

Setting a System Property

Depending on the operating system and type of installer, you can set a Java system property in multiple ways:
  • [Windows/Linux Installer] When installing the application on Windows or Linux using the provided installation kit, you can create your own custom startup parameters file in the installation folder.
  • [macOS Installer] In the application installation folder, locate the Info.plist file similarly to this procedure. Look for the VMOptionArray key and add the system property in a new <string> element from the <array> element. For example:
    <key>VMOptionArray</key>
    <array> 
      <string>-Dproperty.name=value</string>
      ...
    </array>
  • [Windows Linux/Mac Startup Scripts] The application also contains startup scripts in the installation folder. If you are using such scripts to start the application, you can follow this procedure to set system properties for them: Setting Parameters in the Command-Line Scripts.
Note: You can also set a system property through a parameter prefixed with -Doxy in the command line used to start the application:
oxygen20.1.exe "-Doxyproperty.name=value"
but this system property will be set immediately after the application starts and might not be available if it is needed sooner.

To check the value for a system property, you can select Help > About from the main menu and look in the System properties tab.

To view the list of Oxygen XML Editor system properties, go to Custom System Properties.

Disabling DPI Scaling

Some users may prefer the look of smaller icons in an HiDPI display. To achieve this, display scaling needs to be disabled for high DPI settings. To disable the DPI scaling, set the following property:
sun.java2d.dpiaware=false

Setting Environment Variables

When started, the application inherits and can access all environment variables set in the operating system. All processes started by the application (for example, publishing using the DITA Open Toolkit engine or starting external tools) also inherit the environment variables provided to the application. Depending on the operating system, environment variables can be set in various ways:
  • [Windows] (Note: You will need Administrator permissions or to work with a system administrator):
    1. Go to Start > Edit the system environment variables > Environment Variables.
    2. Click New in the System variables section.
    3. Specify the variable name and value in the Name and Value fields.
    4. Click OK.
    5. Restart Windows.
  • [Linux]:
    1. Append the following line to the /etc/environment file:

      ENV_VAR_NAME=VALUE

    2. Reboot the computer.
  • [macOS]: There is no standard way to set an environment variable so that it is inherited by the applications regardless of the way they start.

To check the value for an environmental variable, you can select Help > About from the main menu and look in the System properties tab.

Edit online

Setting Parameters in the Command-Line Scripts

If you start Oxygen XML Editor with a command-line script (oxygen.bat/oxygen.sh ), you have to add or modify parameters in the java command at the end of the script.

For example, to set the maximum amount of Java memory to 600 MB in Windows, modify the -Xmx parameter like this:

java -Xmx600m -Dsun.java2d.noddraw=true ...

On macOS, the java command should look like this:

java "-Xdock:name=Oxygen"\
 -Dcom.oxygenxml.editor.plugins.dir="$OXYGEN_HOME/plugins"\
 -Xmx600m\
 ...
On Linux, the Java command should look like this:
java -Xmx600m\ 
"-Dcom.oxygenxml.editor.plugins.dir=$OXYGEN_HOME/plugins"\
Edit online

Creating Custom Startup Parameters File

You can create your own custom .vmoptions file and the application and the executable tools will automatically include your custom parameters at startup. The following custom files are recognized by the application and the executable tools:
  • custom_commons.vmoptions - The parameters and their values of this file will be included in all the startup launchers.
  • custom_<app name>.vmoptions - The <app name> is the name of the executable application or tool (for example, custom_diffFiles.vmoptions for the Compare Files tool). The parameters and their values of this file will be included in the startup launcher for this particular executable.

For example: To specify a different language for all launchers you can use the custom vmoptions file called custom_commons.vmoptions and the content would look like this:

-Dcom.oxygenxml.language=French
For example: To increase the memory available for a specific tool, such as the Compare Files tool (diffFiles.exe), you can use a custom vmoptions file called custom_diffFiles.vmoptions and the content would look like this:
-Xmx1000m

To be recognized and included, these custom startup parameter files must be saved in the installation directory of Oxygen XML Editor.