Execute Utility

You can use Tikal to launch the execution of a utility, directly, or editing the utility options or the filter parameters just before.

Syntax

The generic syntax for executing a utility is:

C:\>tikal [<util> ]-x <optFile>|- <input> <settings>[ <options>]

Where:

• The optional <util> is the utility set and utility identifiers, for example: oku_set01:extraction, or oku_set01:rewriting.
  • If you do not specify a utility set identifier and the options file already exists, the utility information is taken from the options file.
  • If you do not specify a utility set identifier and the options file does not exist, oku_set01 is to be used by default. If you do not specify a utility identifier either, oku_set01:extraction is used by default.
• <optFile> is the options filename. The file can have any extension you want. You can also use - instead of a filename to specify to use the default options for the given utility.
• <input> is the input file. You can use wildcard characters.
• <settings> is the filter settings. See the Filter Settings definition for more information on this parameter. Note that some utilities may not need this parameter in that case any dummy string can be used.
• <options> is a set of possible options:
  • -ie|-se <encoding> is the input/source encoding, with <encoding> being the IANA encoding name.
  • -oe|-te <encoding> is the output/target encoding, with  <encoding> being the IANA encoding name.
  • -il|-sl <language> is the input/source language, with <language> being the RFC-3066 language tag.
  • -ol|-tl <language> is the output/target language, with <language> being the RFC-3066 language tag.
  • -eu indicates that the user should be prompted to edit the utility options before the execution of the utility.
  • -ef indicates that the user should be prompted to edit the filter parameters prior the execution of the utility.
  • -np indicates that the utility must not prompt the user during the execution (for example to confirm the overwriting of output files).
  • -nb indicates that Tikal should not display its banner.

Note that the usage of the options depends on the filter and the utility. For example some filter detect automatically the encoding of the input file, ignoring the one you specify in the command-line. Also some utilities may choose to force an output to a given encoding regardless what you specify. See the documentation for each filter and utility to see which of the common parameters are required and how they are used.

Examples

C:\>tikal extraction -x - *.po okf_po@myParams -eu -il en-us -ol de -np

Extract all PO files in the current folder using the default options for that utility, and prompting the user to edit these options before running the extraction. The source language is set to English-US and the target language to German. No prompt is allowed during the execution of the utility (prompting for options occurs before the utility is executed).

C:\>tikal oku_set01:merging -x POMerging.opt Output\PO\Work\test02.po.xlf zzz

Merge the XLIFF file Output\PO\Work\test02.po.xlf (from the current folder) into its original format, using options set in the POMerging.opt file. Note the zzz string: It stands for the <settings> parameter which is mandatory. Since the Text Merging utility takes it information from the XLIFF document it does not matter what filter settings you specify here: it will be ignored.