DOWNLOAD AND INSTALLATION

Download the file speagram-0.3.zip from the SourceForge.net website which hosts Speagram release files. It will take you some four or five clicks before the actual download begins. After you have downlaoded this file, unpack it into any folder on your hard drive and the installation will be complete. (There is no installation or setup.)

In the speagram-0.3 folder click speagram.exe under Windows or type ./speagram under Linux. An open session will start ready to process your input. The following message should appear on your screen.

WELCOME TO SPEAGRAM, PARSING INPUT:

>

Simple Example to Get You Started

To get started, copy the following code and paste it into an open Speagram session. (You can also create a file named aaa.spg containing this code and run the command speagram.exe < aaa.spg in the console window.)

Load state library:/basic.

New function natural number ''!'' as natural number.
Variable n as natural number.
Let 0! be 1.
Let n! be (n-1)! * n.
Close context.

0!.
1!.
2!.
3!.
4!.

Speagram Command-line Options

Once you are able to successfully run Speagram you will most probably want to execute it from some scripts or other programs or get additional information from Speagram. Here we describe the available options.

  -f force Speagram to fail on bad parses
  -v make Speagram output verbose
  -m show OCaml calculation of memory use when quitting
  -c work in batch mode and not interactive mode
  -x output in internal XML format and not in the readable one
  -l [path] set path to read the library from
  -o [filename] save parsed terms to file in Speagram parsed format
  -g [filename] save corresponding SRGS grammar to file
  -s [filename] save corresponding XSLT to file
  -b print built-in language definitions
  -h display this list of options

Go to the Developer's Corner if you want to take part in the development of Speagram and do not hesitate to contact us about any questions related to Speagram.