GF Resource Grammar Library (RGL)
The GF Resource Grammar Library is the standard library for Grammatical Framework. It covers the morphology and basic syntax of over 30 languages.
For more about the RGL, see the synopsis page.
Choose your build method
There are 3 ways to build and install the RGL:
- Haskell script
- Shell script
Setup.sh(does not require Haskell)
- Windows batch file
Setup.bat(does not require Haskell)
The install scripts will try to determine where to copy the compiled RGL modules. It will look for, in this order:
--dest=flag (see below)
- the file
../gf-core/DATA_DIR(relative to this directory). This only works if you have the
gf-rglrepositories in the same top-level directory and you have already compiled GF from source. (This is considered a bit hacky and will probably disappear in the future).
A list of all languages and their properties is maintained centrally in
This file should be kept up-to-date and all build methods should read this config file.
If you see something wrong, please report/fix it.
|1||Code||3-letter language code, e.g.
|2||Name||language name in English, e.g.
|3||Directory||folder name under
|4||Functor||functor name (not used)||-|
|5||Unlexer||unlexer (not used)||-|
|6||Present||language is marked with
|11||Synopsis||include language in the RGL synopsis||n|
If default is
y then anything other than
n, including the empty string, is treated as true (and vice versa when default is
If you have
Make installed and don't care about advanced settings,
you can compile the RGL and install it to the default location with:
This is the same as
make build followed by
There is also
make clean available.
The Makefile will try to use the Haskell install script, falling back to the shell script if you do not have Haskell installed.
This build method gives you most options. You will need Haskell installed on your system.
Run the build script with:
runghc Setup.hs ...
... is one of:
build [CMDS] [MODE] [--langs=[+|-]LANG,LANG,...] [--gf=...] [--verbose|-v] copy [MODE] [--dest=...] install [CMDS] [MODE] [--langs=[+|-]LANG,LANG,...] [--gf=...] [--dest=...] [--verbose|-v] clean
CMDSis one or more of:
compat, or an explicit module name (e.g.
ExtraEng.gf. You don't need to specify to language subdirectory, but there is a restriction that the module must exist in a direct subdirectory of
src). If ommitted, the default command is
MODEis one of:
alltenses(default is both).
LANGis a 3-letter language code, e.g.
- You can override the default language list with
You can add languages to the default list with
- You can remove languages from the default list with
- The path to GF installed on your system can be specified via the
--gfflag (default is that the
gfexecutable is in the global system path).
--destflag can be used to manually specify where the compiled RGL modules should be copied/installed. This is the same place as
This method is provided as an alternative for those who don't have Haskell installed. Simply run the script to build the entire RGL and install in the default location.
You can pass the following flags:
--dest=...to manually specify the install location
--gf=...to specify the path to the
gfexecutable, if not available on the system path
-vto show a list of files being built (errors will always be shown)
Windows batch file:
This method is provided as an alternative for Windows users who don't have Haskell or Bash installed.
It is supposed to be a port of
Setup.sh and works in largely the same way.
In particular, it accepts the same flags (in the same format) as described above.
However it currently tries to build all modules for all languages and doesn't consider the details of which modules should be compiled for each language (specified in
About this repository
On 2018-07-25, the monolithic GF repository was split in two: