# Installing and Running OmegaT

- Linux (Intel) users
  - Package to download
  - Installation
  - OS menu setup
    - in KDE
    - in GNOME
  - Running OmegaT
- Windows users
  - Package to download
  - Installation
  - Windows menu setup
  - Running OmegaT
- MacOSX users
  - Package to download
  - Installation
  - Dock setup
  - Running OmegaT
- Other systems (Solaris SPARC/x86/x64, Linux x64/PowerPC, Windows x64)
  - Package to download
  - Installation
  - OS menu setup
  - Running OmegaT
- Command line launching
  - Opening a command-line window
  - Changing the launch script
  - Launch command arguments
- Building OmegaT from source
  - Package to download
  - Build process

# Linux (Intel) users

## Which package to download ?

Do you have a Java implementation compatible with SUN's Java 1.4 JRE?

→ Yes
  download `OmegaT_1.7.3_Without_JRE.zip`
  *This package can be used on any platform where a Java 1.4 JRE compatible JRE is installed.
→ No / I don't know
  download `OmegaT_1.7.3_Linux.tar.gz`
  *This package is bundled with SUN's Java Runtime Environment. This JRE will not interfere with other Java implementations that may already be installed on your system.

## OmegaT installation

To install OmegaT, simply unpack/untar the downloaded file. This will create an omegat/ directory in the working directory in which you will find all the files necessary to run OmegaT.

To untar the `.tar.gz` file:

`$ tar xf downloaded_file.tar.gz`

## Adding OmegaT to your menus (KDE) or panels (Gnome)

### KDE users

You can add OmegaT to your menus as follows:

- `Control Center - Desktop - Panels - Menus - Edit K Menu - File - New Item/New Submenu`
- Then, after selecting a suitable menu, add a submenu/item with `File - New Submenu and File - New Item`. Enter OmegaT as the name of the new item.
- In the "Command" field, use the navigation button to find your OmegaT launch script (the file named OmegaT in the unpacked directory), and select it.
- Click on the icon button (to the right of the Name/Description/Comment fields) - Other Icons - Browse, and navigate to the /images subfolder in the OmegaT application folder. Select the OmegaT.png icon.
- Finally, save the changes with `File - Save`.

### Gnome users

You can add OmegaT to your panel (the bar at the top of the screen) as follows:

- Right-click on the panel - `Add New Launcher`.
- Enter "OmegaT" in the "Name" field; in the "Command" field, use the navigation button to find your OmegaT launch script (the file named OmegaT in the unpacked directory). Select it and confirm with OK.

## Running OmegaT

Once OmegaT is installed, you can launch it directly from the command line, you can create a script that includes launch parameters for the command line or you can click on `OmegaT.jar` to launch it directly. Methods differ depending on the distribution. Make sure that your `PATH` settings are correct and that `.jar` files are properly associated with a Java launcher.

# Windows users

## Which package to download ?

Do you have a Java implementation compatible with SUN's Java 1.4 JRE?

→ Yes
  download `OmegaT_1.7.3_Without_JRE.zip`
  *This package can be used on any platform on which a Java JRE 1.4 compatible JRE is installed.
→ No / I don't know
  download `OmegaT_1.7.3_Windows.zip`
  *This package is bundled with SUN's Java Runtime Environment. This JRE will not interfere with other Java implementations that may already be installed on your system.

## OmegaT installation

To install OmegaT, create a suitable folder, in which to copy the downloaded file (e.g. `C:\Program Files\OmegaT`). Double click on it to unpack it. You will you will find all the files necessary to run OmegaT unpacked in that folder. You may then delete the remaining downloaded file.

## Adding OmegaT to the start menu or desktop

You can drag the files `OmegaT-JRE.exe`, `OmegaT.exe` or `OmegaT.bat` to the desktop or Start menu to link them from there.

## Running OmegaT

Once OmegaT is installed, you can click on `OmegaT.jar` to launch it directly, you can click on the `OmegaT.bat` file to include launch parameters for the command line or you can launch it directly from the command line.

# MacOSX users

## Which package to download ?

Download `OmegaT_1.7.3_MacOSX.zip`.

## OmegaT installation

Double click on `OmegaT_1.7.3_MacOSX.zip` to unpack it. An OSX disk image (`OmegaT.dmg`) will mount itself and will display 2 files: `documentation.html` and `OmegaT.app`. Copy the two files to a suitable folder (e.g. Applications, in which you can create an OmegaT folder). Once you have done this, you can delete the `OmegaT_1.7.3_MacOSX.zip` file.

## Adding OmegaT to the Dock

You can add OmegaT to the Dock by dragging the file `OmegaT.app` and dropping it on the Dock.

## Running OmegaT

Double-click on `OmegaT.app` or click on its location in the Dock

If you want to change the Java launch parameters from the command line, you are advised to use the package available for "Other systems", see below. It is also possible to directly modify the `Info.plist` file located inside the `OmegaT.app` package.

# Other systems

## Which package to download ?

OmegaT is available bundled with a SUN Java JRE for Linux (Intel x86) and Windows platforms. Users of other platforms (Linux PowerPC, Linux x64, Solaris SPARC/x86/x64, Windows x64 etc) must have a running compatible Java JRE on their system to be able to use OmegaT.

Do you have a Java implementation compatible with SUN's Java 1.4 JRE?

→ Yes
  download `OmegaT_1.7.3_Without_JRE.zip`
  *This package can be used on any platform where a Java 1.4 JRE compatible JRE is installed.
→ I don't know
  open a terminal and type "java -version". If a "command not found" or similar message is returned, it is likely that Java is not installed on your system.
→ No
  obtain a Java JRE for your system (see below) and download `OmegaT_1.7.3_Without_JRE.zip`.

  SUN provides JREs for Solaris SPARC/x86 (Java 1.4) and for Linux x64, Solaris x64, Windows x64 (Java 1.5):
  http://java.sun.com/products/archive/
  IBM provides JREs for Linux PowerPC:
  http://www.ibm.com/developerworks/java/jdk/linux/download.html

Follow the installation instructions of the package you need.

## OmegaT installation

To install OmegaT, simply unpack the `OmegaT_1.7.3_Without_JRE.zip` file. This creates an `./OmegaT_1.7.3_Without_JRE/` directory in the working directory in which you will find all the files necessary to run OmegaT.

## Installing convenient shortcuts

Follow your system's instructions to install OmegaT shortcuts in convenient places.

## Running OmegaT

Once OmegaT is installed, you can launch it directly from the command line, you can create a script that includes launch parameters for the command line or you can click on `OmegaT.jar` to launch it directly. Methods differ depending on the distribution. Make sure that your `PATH` settings are correct and that `.jar` files are properly associated with a Java launcher.

# Command line launching

Normally, it is not necessary to launch OmegaT from the command line. However, the command-line method of launching OmegaT enables aspects of the program's behaviour to be controlled by means of modifications. There are two ways of launching OmegaT using the command line.

Users of the Mac OSX package who want to control OmegaT from the command line are advised to use the package available for "Other systems". See above.

## Method 1: opening a command-line window

A command-line window is also referred to as a "terminal window". On Windows it is called an "MS-DOS window" and is available from the Start Menu, inside Programs, through the "MS-DOS" item. The Mac OSX equivalent is the application Terminal located in Applications → Utilities.

To launch OmegaT, you must normally type two commands. The first of these is:

`cd {folder}`

where `{folder}` is the name of the folder, with complete path, in which your OmegaT program - specifically, the file `OmegaT.jar` - is located. In practice, this command will therefore be something like this:

On Windows
  `cd C:\Program Files\OmegaT`
On Mac OSX
  `cd /Applications/OmegaT`
On Linux
  `cd /usr/local/omegat`

This command changes the folder to the folder containing the executable OmegaT file. The second command is the command which actually launches OmegaT. In its most basic form, this command is:

`java -jar OmegaT.jar`

Pay attention to the capitalization - it is important.

This method has a particular benefit of being suitable for debugging: if an error occurs during use of the program, an error message is output in the terminal window which may contain useful information on the cause.

## Method 2: changing the `.bat` file/launch script

Method 1 is a somewhat impractical way of launching a program routinely. For this reason, the two commands described above are contained in a file (a "script", also called a "`.bat` file" on Windows systems).

When this file is executed, the commands within it are automatically carried out. Consequently, to make changes to the launch command, it is sufficient to modify the file. When OmegaT is launched from the file, the new commands are then executed.

## Launch command arguments

The basic command has already been mentioned above. Changes to this command involve the addition of "arguments" to it. Arguments are added after the initial "`java`", and before the "`-jar OmegaT.jar`" part.

A list of possible arguments follows. You can have more information about the arguments by typing `man java` in the terminal window. `man` is a terminal window command that displays a manual of the selected command. Your system may or may not have a manual for the command `java` in your language.

`-Duser.language=XX`

  Normally, i.e. when OmegaT is launched without any arguments, the program first detects the language of the user's operating system. If a user interface in this language is available, OmegaT uses it. So, if the user's operating system is Russian and OmegaT has been localized in Russian, OmegaT is displayed with a Russian user interface, Russian menus, etc. If the language of the user's system is not available, OmegaT defaults to English. This is the standard behaviour.

  The "`-Duser.language=XX`" argument causes OmegaT to use the language specified rather than the language of the user's operating system. "XX" in the command stands for the two-digit code of the desired language. To launch OmegaT with a French interface (for example on a Russian operating system), the command would therefore be:

  `java -Duser.language=fr -jar OmegaT.jar`

`-Duser.country=XX`

  Next to the language, you can also specify the country, for example CN or TW in case of the Chinese language. To get the correct Instant start guide, you need to specify both the language and the country. This is necessary even if there's only one combination available, like pt_BR in case of Portuguese / Brazil. .

`-Dswing.aatext=true`

  This argument effects anti-aliasing of the fonts, thereby improving their appearance.

`-XmxZZM`

  This command assigns more memory to OmegaT. By default, 256 MB are assigned, so there is no advantage in assigning less than this figure. "ZZ" stands for the amount of memory assigned, in megabytes. The command to launch OmegaT with assignment of 1024 MB (1 gigabyte) of memory is therefore:

  `java -Xmx1024M -jar OmegaT.jar`

Arguments can be combined. To launch OmegaT with all the examples described above, the command would be:

`java -Dswing.aatext=true -Duser.language=pt -Duser.country=BR -Xmx1024M -jar OmegaT.jar`

# Building OmegaT from source

## Which package to download ?

Download OmegaT_1.7.3_Source.zip
  This package contains the source files corresponding to the released version and can be used on any system that is installed with a Java 1.4 JDK or compatible Java system. You will also need the ant utility to build OmegaT.
You can also get the most recent code from the CVS server:
  `cvs -z3 -d:pserver:anonymous@omegat.cvs.sourceforge.net:/cvsroot/omegat co -P omegat`

## Building OmegaT

  Unpack the OmegaT_1.7.3_Source.zip file and enter the OmegaT_1.7.3_Source directory or enter the ./omegat/ directory of the CVS checked out code. Check that a build.xml file is present in that directory. Then, on the command line, type:

`$ ant jar release`

  This will create a full distribution of OmegaT in the ./dist/ directory, in which you will find all the files necessary to run OmegaT.

Legal notices