thrax/README at master · mjansche/thrax · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Thrax - Release 1.2.8

Thrax is a toolkit for compiling grammars based on regular expressions and
context-dependent rewrite rules into weighted finite-state transducers
(FSTs). The FST representation uses OpenFst.

REQUIREMENTS:
  This version is known to work under Linux and MacOS using g++ (>=
  4.2). Expected to work wherever adequate POSIX (dlopen, ssize_t, basename),
  c99 (snprintf, strtoll, <stdint.h>), and C++11 with GNU extensions are
  available.

  It is assumed you have OpenFst (www.openfst.org) 1.7.1 or higher and have
  installed it.

  MAKE SURE YOU CONFIGURE OpenFst WITH THE --enable-far, --enable-pdt AND
  --enable-mpdt FLAGS. Starting with OpenFst 1.6.0, you can also just use
  --enable-grm.

INSTALLATION:
  Follow the generic GNU build system instructions in ./INSTALL.  We
  recommend configuring with =--enable-static=no= for faster
  compiles.

  Configuring with --enable-bin=no excludes the command line utilities (not
  generally useful).

  Configuring with --enable-readline enables readline (in-line editing) for
  thraxrewrite-tester. You must have GNU readline installed.

  Compiling with '-Wall -Wno-sign-compare' under g++ should give no
  warnings from this library.

USAGE:
  Assuming you've installed under the default /usr/local, the GRM binaries are
  found on /usr/local/bin. Headers will be in /usr/local/include/thrax, and
  libraries in /usr/local/lib.

  Auxiliary data files -- provided grammars -- are under /usr/local/share/thrax.
  Syntax highlighters (for vi and emacs) and other useful tools are under
  /usr/local/share/utils.

  To use in your own programs you will need to include <thrax/thrax.h>. Compile
  with '-I /usr/local/include' and link against /usr/local/lib/libfst.so,
  /usr/local/lib/fst/libfstfar.so and /usr/local/lib/libthrax.so

  The linking is, by default, dynamic so that the Fst and Arc type DSO
  extensions can be used correctly if desired.

DOCUMENTATION:
  See www.opengrm.org for general documentation.
  See ./NEWS for updates since the last release.