File: INSTALL.md

package info (click to toggle)
alt-ergo 2.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,096 kB
  • sloc: ml: 28,606; makefile: 15; sh: 12
file content (111 lines) | stat: -rw-r--r-- 3,656 bytes parent folder | download | duplicates (2)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
## Build and Installation

  You need OCaml >= 4.04.0, zarith, camlzip, menhir and ocplib-simplex >= 0.4
  to compile the sources. You need LablGtk2 and the widget
  GSourceView2 to compile the GUI. You may need superuser permissions
  to perform the installation.

#### Common Steps

  1. If a configure file is not distributed with the sources, then
  run "autoconf"

  2. Configure with "./configure" to generate Makefile.configurable

  3. Alternatively, you can configure with "./configure -prefix
  some-absolute-path-prefix" to add a prefix for installation
  directories. You may also want to use "make show-dest-dirs" to see
  directories where things will be installed.

The steps below will build and install native or bytecode binaries
depending on whether ocamlopt is installed or only ocamlc is detected.

#### Everything (binaries, plugins, ...)

  1. Compile with "make"

  2. Install with "make install"
 
  3. Uninstall with "make uninstall"

#### Alt-Ergo binary

  1. Compile with "make alt-ergo"

  2. Install with "make install-ae"
 
#### AltGr-Ergo binary

  1. Compile with "make gui"
  
  2. Install with "make install-gui"


The steps below will build and install additional plugins (extension
.cmxs if ocamlopt is installed or .cma if only ocamlc is detected).

#### The SatML Plugin

  1. Compile with "make satML"

  2. Install with "make install-satML"

#### The Fm-Simplex Plugin

  1. Compile with "make fm-simplex"

  2. Install with "make install-fm-simplex"

#### The profiler plugin

This plugin has been "inlined" in Alt-Ergo sources.

## Usage

- Alt-Ergo and AltGr-Ergo are executed with the following commands,
  respectively:

        $ alt-ergo   [options] file.why
        $ altgr-ergo [options] file.why

- The SatML plugin can be used as follows: 

        $ alt-ergo -sat-plugin satML-plugin.cmxs [other-options] file.why
        $ alt-ergo -sat-plugin some-path/satML-plugin.cmxs [other-options] file.why

   Alt-Ergo will try to load a local plugin called
   "satML-plugin.cmxs". If this fails, Alt-Ergo tries to load it from
   the default plugins directory (run "alt-ergo -where plugins" to
   see its absolute path). You can also provide a relative or an
   absolute path as shown by the second command above. Also, you
   should replace ".cmxs" by ".cma" if you are working with bytcode
   binaries.

- The Fm-Simplex plugin can be used as follows:

        $ alt-ergo -inequalities-plugin fm-simplex-plugin.cmxs [other-options] file.why
        $ alt-ergo -inequalities-plugin some-path/fm-simplex-plugin.cmxs [other-options] file.why

   Alt-Ergo will try to load a local plugin called
   "fm-simplex-plugin.cmxs". If this fails, Alt-Ergo tries to load it
   from the default plugins directory (run "alt-ergo -where plugins"
   to see its absolute path). You can also provide a relative or an
   absolute path as shown by the second command above. Also, you
   should replace ".cmxs" by ".cma" if you are working with bytcode
   binaries.

- Preludes can be passed to Alt-Ergo as follows:

        $ alt-ergo -prelude p.why -prelude some-path/q.why [other-options] file.why

   Alt-Ergo will try to load a local plugin called "p.why". If this
   fails, Alt-Ergo tries to load it from the default preludes
   directory (run "alt-ergo -where preludes" to see its absolute
   path). You can also provide a relative or an absolute path as shown
   by "some-path/q.why".

   For instance, the following command-line enables floating-point
   arithmetic reasoning in Alt-Ergo and indicates that the FPA prelude
   should be loaded:

   $ alt-ergo -use-fpa -prelude fpa-theory-2017-01-04-16h00.why <file.why>