trunk/apertium/README

   1 REQUIREMENTS
   2
   3 * This package needs lttoolbox-3.0 package  installed in the
   4 system.
   5
   6 DESCRIPTION
   7
   8 When building, this package generates the following modules:
   9
  10 * apertium-deshtml, apertium-desrtf, apertium-destxt
  11   Deformatters for html, rtf and txt document formats.
  12
  13 * apertium-rehtml, apertium-rertf, apertium-retxt
  14   Reformatters for html, rtf and txt document formats.
  15
  16 * apertium-gen-tagger
  17   Tagger modules generator.
  18
  19 * apertium-gen-transfer
  20   Transfer modules generator.
  21
  22 * apertium
  23   Translator program.  Execute without parameters to see the usage.
  24
  25 QUICK START
  26
  27 1) Download the packages for lttoolbox-VERSION.tar.gz and
  28    apertium-VERSION.tar.gz and linguistic data
  29
  30 2) Unpack lttoolbox and do ('#' means 'do that with root privileges'):
  31    $ cd lttoolbox-VERSION
  32    $ ./configure
  33    $ make
  34    # make install
  35
  36 3) Unpack apertium and do:
  37    $ cd apertium-VERSION
  38    $ ./configure
  39    $ make
  40    # make install
  41
  42 4) Unpack linguistic data (LING_DATA_DIR) and do:
  43    $ cd LING_DATA_DIR
  44    $ make
  45    and wait for a while (minutes).
  46
  47 5) Use the translator
  48
  49    USAGE: apertium [-d datadir] [-f format] [-u] <translation> [in [out]]
  50     -d datadir       directory of linguistic data
  51     -f format        one of: txt (default), html, rtf
  52     -u               don't display marks '*' for unknown words
  53     translation      typically, LANG1-LANG2, but see modes.xml in language data
  54     in               input file (stdin by default)
  55     out              output file (stdout by default)
  56
  57
  58    Sample:
  59
  60    $ apertium es-ca txt <input >output