Tikal - Usage

From Okapi Framework
Jump to: navigation, search

Running Tikal

Tikal is a command-line tool. To run it you need to be in a DOS or shell console.

  • On Windows you can start a DOS prompt by executing the file named startTikalPrompt.bat that is located in the main directory of the Okapi installation.
  • On Linux and Macintosh you need first to open a shell console, then you can use the file tikal.sh that is located in the main directory of the Okapi installation.

Note that if you want to be able to always access Tikal from any prompt, you main have to setup your system so tikal.bat or tikal.sh are in your search path.

There are various commands available:

Source and Target Languages

Most commands in Tikal require a source language, a target language or both to be specified. The values of those parameters is computed using the following process:

Source Language

If the option -sl is used:
→ its value is used as the source language.
Else:
If the input file is in a format where Tikal detects language settings (XLIFF, TMX, TTX, etc.):
If a source language is detected:
→ that value is used as the source language.
If no source language has been set yet:
→ English (en) is used as the source language.

Target Language

If the option -tl is used:
→ its value is used as the target language.
Else:
If the input file is in a format where Tikal detects language settings (XLIFF, TMX, TTX, etc.):
If a target language is detected:
→ that value is used as the target language.
If no target language has been set yet:
→ The language corresponding to the current value of the default locale for the running Java VM is used, except if it is the same as the source language; in that case French (fr) is used as the target language.

Display Encoding

In order to display characters properly with Tikal, you must make sure the display encoding of your shell session (e.g. DOS or bash) is the same as the output generated by Tikal.

The default depends on the operating system and may not be guessed correctly in many cases.

The user can override the guess by specifying the encoding to use in Tikal in a configuration file named .Tikal and located in the user's home directory. The system is

displayEncoding=<javaEncodingName>

For example, the following will change the encoding of the Tikal display output to UTF-8:

displayEncoding=UTF-8

Note that changing the display encoding does not affect the encoding of the output files, only the way the string are displayed on the terminal.

Logging and trace

You can pass the -logger flag to output all messages to the current logger instead of the console. Might be pretty noisy, but you have full control by tweaking the logger configuration. You can find more info on logging here: http://code.google.com/p/okapi/wiki/OkapiLogging.

When passed the -trace flag tikal outputs all debug messages from other components to the console. This has no effect when the -logger flag is in effect, as the logger gets full control on the output.

Help and Information

  • Use -? to display the usage screen for Tikal.
  • Use -h, -help or --help to display this help page.
  • Use -i, -info or --info to version and other information.

Examples:

tikal -?
tikal --help
tikal -info

Note that these three commands preempt any other commands. For example, the following command will only show the usage screen, not extract any file:

tikal -x myFile.html -sl zu -tl eo -?