1

STRGEN USAGE

     2

------------

     3

This guide is only interesting for people who want to alter something

     4

themselves without access to WT2 (translator2.openttd.org). Please note that

     5

your compiled language file will only be compatible with the OpenTTD version

     6

you have downloaded english.txt, the master language file, for. While this is

     7

not always true, namely when changes in the code have not touched language

     8

files, your safest bet is to assume this 'limitation'.

     9

As a first step you need to compile strgen. This is as easy as typing

    10

'make strgen'. You can also download a precompiled binary from a release,

    11

nightly, etc.

    12

strgen takes as argument a txt file and translates it to a lng file, allowing

    13

it to be used inside OpenTTD. strgen needs the master language file

    14

english.txt to work. Below are some examples of strgen usage.

    15

    16

EXAMPLES

    17

--------

    18

Example 1:

    19

if you are in the root of your working copy (svn code), you should type

    20

strgen/strgen -s lang lang/english.txt

    21

to compile englist.txt into english.lng. It will be placed in the lang dir

    22

    23

Example 2:

    24

you only have the strgen executable (no working copy) and you want to compile

    25

a txt file in the same directory. You should type

    26

./strgen english.txt

    27

and you will get and english.lng in the same dir

    28

    29

Example 3:

    30

you have strgen somewhere, english.txt in /usr/openttd/lang and you want the

    31

resulting language file to go to /tmp. Use

    32

./strgen -s /usr/openttd/lang -d /tmp english.txt

    33

    34

You can interchange english.txt to whichever language you want to generate a

    35

.lng file for.

    36

    37

STRGEN COMMAND SWITCHES

    38

-----------------------

    39

-v | --version

    40

strgen will tell what svn revision it was last modified

    41

    42

-t | --todo

    43

strgen will add <TODO> to any untranslated/missing strings and use the english

    44

strings while compiling the language file

    45

    46

-w | --warning

    47

strgen will print any missing strings or wrongly translated (bad format)

    48

to standard error output(stderr)

    49

    50

-h | --help | -?

    51

Print out a summarized help message explaining these switches

    52

    53

-s | --source_dir

    54

strgen will search for the master file english.txt in the directory specified

    55

by this switch instead of the current directory

    56

    57

-d | --dest_dir

    58

strgen will put <language>.lng in the directory specified by this switch; if

    59

no dest_dir is given, output is the same as source_dir