README
1Apertium
2===============================================================================
3
4Requirements
5-------------------------------------------------------------------------------
6
7* This package needs the package [lttoolbox-3.5][1] installed in the
8system, as well as `libxml` and `libpcre`.
9
10See http://www.apertium.org and http://wiki.apertium.org for more information
11on installing.
12
13Description
14-------------------------------------------------------------------------------
15
16When building, this package generates, among others, the following
17modules:
18
19* `apertium-deshtml`, `apertium-desrtf`, `apertium-destxt`
20 Deformatters for html, rtf and txt document formats.
21* `apertium-rehtml`, `apertium-rertf`, `apertium-retxt`
22 Reformatters for html, rtf and txt document formats.
23* `apertium`
24 Translator program. Execute without parameters to see the usage.
25
26Quick Start
27-------------------------------------------------------------------------------
28
291) Download the packages for `lttoolbox-VERSION.tar.gz` and
30 `apertium-VERSION.tar.gz` and linguistic data
31
32 Note: If you are using the translator from GitHub, run `./autogen.sh` before
33 running `./configure` in all cases.
34
352) Unpack lttoolbox and do ('#' means 'do that with root privileges'):
36```
37 $ cd lttoolbox-VERSION
38 $ ./configure
39 $ make
40 # make install
41```
423) Unpack apertium and do:
43```
44 $ cd apertium-VERSION
45 $ ./configure
46 $ make
47 # make install
48```
494) Unpack linguistic data (LING_DATA_DIR) and do:
50```
51 $ cd LING_DATA_DIR
52 $ ./configure
53 $ make
54 and wait for a while (minutes).
55```
565) Use the translator
57
58```
59 USAGE: apertium [-d datadir] [-f format] [-u] <direction> [in [out]]
60 -d datadir directory of linguistic data
61 -f format one of: txt (default), html, rtf, odt, docx, wxml, xlsx, pptx,
62 xpresstag, html-noent, latex, latex-raw
63 -a display ambiguity
64 -u don't display marks '*' for unknown words
65 -n don't insert period before possible sentence-ends
66 -m memory.tmx use a translation memory to recycle translations
67 -o direction translation direction using the translation memory,
68 by default 'direction' is used instead
69 -l lists the available translation directions and exits
70 direction typically, LANG1-LANG2, but see modes.xml in language data
71 in input file (stdin by default)
72 out output file (stdout by default)
73
74
75 Sample:
76
77 $ apertium -f txt es-ca <input >output
78```
79
80[1]: https://github.com/apertium/lttoolbox
81
README-MODES
README.md
1Apertium
2===============================================================================
3
4Requirements
5-------------------------------------------------------------------------------
6
7* This package needs the package [lttoolbox-3.5][1] installed in the
8system, as well as `libxml` and `libpcre`.
9
10See http://www.apertium.org and http://wiki.apertium.org for more information
11on installing.
12
13Description
14-------------------------------------------------------------------------------
15
16When building, this package generates, among others, the following
17modules:
18
19* `apertium-deshtml`, `apertium-desrtf`, `apertium-destxt`
20 Deformatters for html, rtf and txt document formats.
21* `apertium-rehtml`, `apertium-rertf`, `apertium-retxt`
22 Reformatters for html, rtf and txt document formats.
23* `apertium`
24 Translator program. Execute without parameters to see the usage.
25
26Quick Start
27-------------------------------------------------------------------------------
28
291) Download the packages for `lttoolbox-VERSION.tar.gz` and
30 `apertium-VERSION.tar.gz` and linguistic data
31
32 Note: If you are using the translator from GitHub, run `./autogen.sh` before
33 running `./configure` in all cases.
34
352) Unpack lttoolbox and do ('#' means 'do that with root privileges'):
36```
37 $ cd lttoolbox-VERSION
38 $ ./configure
39 $ make
40 # make install
41```
423) Unpack apertium and do:
43```
44 $ cd apertium-VERSION
45 $ ./configure
46 $ make
47 # make install
48```
494) Unpack linguistic data (LING_DATA_DIR) and do:
50```
51 $ cd LING_DATA_DIR
52 $ ./configure
53 $ make
54 and wait for a while (minutes).
55```
565) Use the translator
57
58```
59 USAGE: apertium [-d datadir] [-f format] [-u] <direction> [in [out]]
60 -d datadir directory of linguistic data
61 -f format one of: txt (default), html, rtf, odt, docx, wxml, xlsx, pptx,
62 xpresstag, html-noent, latex, latex-raw
63 -a display ambiguity
64 -u don't display marks '*' for unknown words
65 -n don't insert period before possible sentence-ends
66 -m memory.tmx use a translation memory to recycle translations
67 -o direction translation direction using the translation memory,
68 by default 'direction' is used instead
69 -l lists the available translation directions and exits
70 direction typically, LANG1-LANG2, but see modes.xml in language data
71 in input file (stdin by default)
72 out output file (stdout by default)
73
74
75 Sample:
76
77 $ apertium -f txt es-ca <input >output
78```
79
80[1]: https://github.com/apertium/lttoolbox
81