Deleting old new pair howto and moving webspace
[apertium.git] / apertium / README
blobe4ee059b44a7b8a85c32ac586ce6a5662e8305fa
1 REQUIREMENTS
3 * This package needs lttoolbox-1.9 package  installed in the
4 system.
6 DESCRIPTION
8 When building, this package generates the next modules:
10 * apertium-deshtml, apertium-desrtf, apertium-destxt
11   Deformatters for html, rtf and txt document formats.
13 * apertium-rehtml, apertium-rertf, apertium-retxt
14   Reformatters for html, rtf and txt document formats.
16 * apertium-gen-tagger
17   Tagger modules generator.
19 * apertium-gen-transfer
20   Transfer modules generator.
22 * apertium-translator
23   Translator program.  Execute without parameters to see the usage.
25 QUICK START
27 1) Download the packages for lttoolbox-VERSION.tar.gz and 
28    apertium-VERSION.tar.gz and linguistic data  
30 2) Unpack lttoolbox and do ('#' means 'do that with root privileges'):
31    $ cd lttoolbox-VERSION
32    $ ./configure
33    $ make
34    # make install
36 3) Unpack apertium and do:
37    $ cd apertium-VERSION
38    $ ./configure
39    $ make
40    # make install
42 4) Unpack linguistic data (LING_DATA_DIR) and do:
43    $ cd LING_DATA_DIR
44    $ make
45    and wait for a while (minutes).  
47 5) Use the translator
48    
49    apertium-translator <datadir> <translation> [format [infile [outfile]]]
50    datadir          Directory of linguistic data
51    translation      LANG1-LANG2
52    format           one of: txt (default), txtu, html, htmlu, rtf, rtfu
53    infile           input file (stdin by default)
54    outfile          output file (stdout by default)
56    Sample:
58    $ apertium-translator LING_DATA_DIR es-ca txt <input >output