1<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2<!-- BEGIN LICENSE BLOCK
3   - Version: CMPL 1.1
4   -
5   - The contents of this file are subject to the Cisco-style Mozilla Public
6   - License Version 1.1 (the "License"); you may not use this file except
7   - in compliance with the License.  You may obtain a copy of the License
8   - at www.eclipse-clp.org/license.
9   - 
10   - Software distributed under the License is distributed on an "AS IS"
11   - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.  See
12   - the License for the specific language governing rights and limitations
13   - under the License. 
14   - 
15   - The Original Code is  The ECLiPSe Constraint Logic Programming System. 
16   - The Initial Developer of the Original Code is  Cisco Systems, Inc. 
17   - Portions created by the Initial Developer are
18   - Copyright (C) 2006 Cisco Systems, Inc.  All Rights Reserved.
19   - 
20   - Contributor(s): 
21   - 
22   - END LICENSE BLOCK -->
23<html>
24<head>
25   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
26   <meta http-equiv="3D&quot;Content-Type&quot;" content="3D">
27   <meta name="3DGENERATOR" content="3D">
28   <meta name="GENERATOR" content="Mozilla/4.76 [en] (X11; U; SunOS 5.7 sun4u) [Netscape]">
29</head>
30<body>
31
32<h1>
33<font size=+1>ECLiPSe Runtime Subset</font></h1>
34Applies to ECLiPSe version: 5.3
35<br>Author: Joachim Schimpf
36<h2>
37<font size=+0>Overview</font></h2>
38<font size=+0>We define a subset of the ECLiPSe system which is appropriate
39and supported for the purpose of running and delivering current (and hopefully
40future) ECLiPSe-based applications.</font>
41<p><font size=+0>Informally, the runtime subset consists of</font>
42<ul>
43<li>
44<font size=+0>the eclipse kernel</font></li>
45
46<li>
47<font size=+0>a basic set of eclipse libraries</font></li>
48
49<li>
50<font size=+0>the libraries for embedding into C/C++</font></li>
51
52<li>
53<font size=+0>the java interface</font></li>
54
55<li>
56<font size=+0>a standalone executable</font></li>
57
58<li>
59<font size=+0>the flexlm licensing functionality</font></li>
60</ul>
61<font size=+0>The runtime subset does <b><i>not</i></b> contain</font>
62<ul>
63<li>
64<font size=+0>any sources</font></li>
65
66<li>
67<font size=+0>any development/debugging tools</font></li>
68
69<li>
70<font size=+0>unsupported/third party libraries</font></li>
71
72<li>
73<font size=+0>Tcl/Tk interface</font></li>
74
75<li>
76<font size=+0>Cplex/Xpress interfaces (these are separately packaged)</font></li>
77</ul>
78
79<h2>
80<font size=+0>Files in the runtime subset (ECLiPSe 5.3)</font></h2>
81<font size=+0>The list below defines the runtime subset for ECLiPSe 5.3
82in terms of the names of the files in the runtime distribution.</font>
83<br><font size=+0>Contents of eclipse_rt.tgz:</font>
84<blockquote><tt><font size=+0>ARCH</font></tt>
85<br><tt><font size=+0>RUNME</font></tt>
86<p><tt><font size=+0>lib/eclipse.jar</font></tt>
87<p><tt>lib/${ARCH}/${LIBPREFIX}ec_java.${LIBSUFFIX}</tt>
88<br><tt>lib/${ARCH}/${LIBPREFIX}ec_java_load.${LIBSUFFIX}</tt>
89<br><tt>lib/${ARCH}/${LIBPREFIX}eclipse.${LIBSUFFIX}</tt>
90<br><tt>lib/${ARCH}/${LIBPREFIX}gmp*.${LIBSUFFIX}*</tt>
91<br><tt>lib/${ARCH}/bitmap.${SOSUFFIX}</tt>
92<br><tt>lib/${ARCH}/eclipse.exe</tt>
93<br><tt>lib/${ARCH}/edge_finder.${SOSUFFIX}</tt>
94<br><tt>lib/${ARCH}/ic.${SOSUFFIX}</tt>
95<br><tt>lib/${ARCH}/pteclipse.${LIBSUFFIX}</tt>
96<p><tt>lib/anti_unify.eco</tt>
97<br><tt>lib/apply.eco</tt>
98<br><tt>lib/apply_macros.eco</tt>
99<br><tt>lib/bin_info.eco</tt>
100<br><tt>lib/branch_and_bound.eco</tt>
101<br><tt>lib/calendar.eco</tt>
102<br><tt>lib/changeset.eco</tt>
103<br><tt>lib/cumulative.eco</tt>
104<br><tt>lib/ech.eco</tt>
105<br><tt>lib/eclipse_language.eco</tt>
106<br><tt>lib/edge_finder.eco</tt>
107<br><tt>lib/edge_finder3.eco</tt>
108<br><tt>lib/edge_finder_common.eco</tt>
109<br><tt>lib/fd.eco</tt>
110<br><tt>lib/fd_arith.eco</tt>
111<br><tt>lib/fd_chip.eco</tt>
112<br><tt>lib/fd_domain.eco</tt>
113<br><tt>lib/fd_elipsys.eco</tt>
114<br><tt>lib/fd_global.eco</tt>
115<br><tt>lib/fd_search.eco</tt>
116<br><tt>lib/fd_sets.eco</tt>
117<br><tt>lib/fd_util.eco</tt>
118<br><tt>lib/fromonto.eco</tt>
119<br><tt>lib/graph_algorithms.eco</tt>
120<br><tt>lib/hash.eco</tt>
121<br><tt>lib/heaps.eco</tt>
122<br><tt>lib/ic.eco</tt>
123<br><tt>lib/ic_constraints.eco</tt>
124<br><tt>lib/ic_kernel.eco</tt>
125<br><tt>lib/ic_search.eco</tt>
126<br><tt>lib/iso.eco</tt>
127<br><tt>lib/joop_boot.eco</tt>
128<br><tt>lib/kernel.eco</tt>
129<br><tt>lib/linearize.eco</tt>
130<br><tt>lib/lists.eco</tt>
131<br><tt>lib/make_overlap_bivs.eco</tt>
132<br><tt>lib/matrix_util.eco</tt>
133<br><tt>lib/notinstance.eco</tt>
134<br><tt>lib/numbervars.eco</tt>
135<br><tt>lib/ordset.eco</tt>
136<br><tt>lib/probe.eco</tt>
137<br><tt>lib/probe_search.eco</tt>
138<br><tt>lib/probe_support.eco</tt>
139<br><tt>lib/probing_for_scheduling.eco</tt>
140<br><tt>lib/propia.eco</tt>
141<br><tt>lib/queues.eco</tt>
142<br><tt>lib/range.eco</tt>
143<br><tt>lib/repair.eco</tt>
144<br><tt>lib/ria.eco</tt>
145<br><tt>lib/shadow_cons.eco</tt>
146<br><tt>lib/sorts.eco</tt>
147<br><tt>lib/strings.eco</tt>
148<br><tt>lib/suspend.eco</tt>
149<br><tt>lib/var_name.eco</tt>
150<p><tt>lib/version.pl</tt></blockquote>
151The file names contain variables with the following meaning:
152<br>&nbsp;
153<dt>
154${ARCH}</dt>
155
156<dd>
157&nbsp;&nbsp;&nbsp;&nbsp; machine/operating system architecture (sparc_sunos5,sun4,i386_linux,i386_nt,alpha_linux)</dd>
158
159<dt>
160${LIBPREFIX}</dt>
161
162<dd>
163&nbsp;&nbsp;&nbsp;&nbsp; "lib" on Unix, empty on Windows</dd>
164
165<dt>
166${LIBSUFFIX}</dt>
167
168<dd>
169&nbsp;&nbsp;&nbsp;&nbsp; "a", "so" or "dll"</dd>
170
171<dt>
172${SOSUFFIX}</dt>
173
174<dd>
175&nbsp;&nbsp;&nbsp;&nbsp; "so" or "dll"</dd>
176
177<h2>
178<font size=+0>Installation of the runtime subset for embedding</font></h2>
179<font size=+0>If you are going to use ECLiPSe in embedded form, installation
180only consists of unpacking:</font>
181<ol>
182<li>
183<font size=+0>Unpack eclipse_rt.tgz</font></li>
184
185<li>
186<font size=+0>Unpack if_xpressXX.tgz or if_cplexXX.tgz if needed</font></li>
187</ol>
188
189<h2>
190<font size=+0>Installation of the runtime subset if you need an eclipse
191executable</font></h2>
192<font size=+0>Unpack as above. If you need a standalone eclipse executable
193on UNIX:</font>
194<ol>
195<li>
196<font size=+0>Invoke RUNME and accept the default options (you can do that
197by calling .<tt>/RUNME &lt;/dev/null</tt>, the only non-default you may
198want is a symbolic path name for the current directory, i.e. ECLIPSEDIR).
199This will create the executable sh-script</font></li>
200
201<br><tt><font size=+0>&lt;installation directory>/bin/${ARCH}/eclipse</font></tt>
202<br><font size=+0>which can then be called directly.</font>
203<li>
204Alternatively, you can omit the previous step, set ECLIPSEDIR and LD_LIBRARY_PATH
205in your environment and call lib/${ARCH}/eclipse.exe directly:</li>
206
207<br><tt>ECLIPSEDIR=&lt;installation directory></tt>
208<br><tt>LD_LIBRARY_PATH=${ECLIPSEDIR}/lib/${ARCH}:${LD_LIBRARY_PATH}</tt>
209<br><tt>export ECLIPSEDIR LD_LIBRARY_PATH</tt>
210<br><tt>${ECLIPSEDIR}/lib/${ARCH}/eclipse.exe</tt>
211<br>Note that this is essentially the same as what the above sh-script
212does.</ol>
213<font size=+0>If you need a standalone eclipse executable on Windows:</font>
214<ol>
215<li>
216<font size=+0>Either make a registry entry HKEY_LOCAL_MACHINE\SOFTWARE\IC-Parc\ECLiPSe\&lt;version>
217(where &lt;version> is the version number, e.g. 5.3) with a string value
218that gives the installation directory in Windows path name syntax. Then
219you can simply execute</font></li>
220
221<br><tt><font size=+0>&lt;installation directory>/lib/i386_nt/eclipse.exe</font></tt>
222<li>
223<font size=+0>Alternatively, you can omit the registry entry and invoke
224eclipse.exe with the -D option:</font></li>
225
226<br><tt><font size=+0>&lt;installation directory>/lib/i386_nt/eclipse.exe
227-D &lt;installation directory></font></tt></ol>
228Note that a standalone eclipse in a runtime installation always needs a
229<tt>-e
230&lt;goal> </tt>command line option because it does not contain an interactive
231toplevel. If this is forgotten you will get the error message
232<br><tt>library not found in ensure_loaded(library(toplevel))</tt>
233<br>&nbsp;
234</body>
235</html>
236