xref: /trunk/main/odk/docs/install.html (revision ef1ef8e6)
1 cdf0e10cSrcweir<html>
2 cdf0e10cSrcweir<head>
3 *ef1ef8e6SJürgen Schmidt  <title>Apache OpenOffice %PRODUCT_RELEASE% SDK - Installation Guide</title>
4 cdf0e10cSrcweir  <link rel="stylesheet" type="text/css" href="sdk_styles.css">
5 cdf0e10cSrcweir  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6 cdf0e10cSrcweir  <meta name="author" content="J&uuml;rgen Schmidt">
7 cdf0e10cSrcweir  <meta name="created" content="2004-12-14">
8 cdf0e10cSrcweir</head>
9 cdf0e10cSrcweir<body class="sdkbody"><a name="install"/>
10 cdf0e10cSrcweir<table class="table1" cellpadding=0>
11 cdf0e10cSrcweir  <tr style="background-image:url(images/sdk_head-2.png)">
12 cdf0e10cSrcweir    <td colspan="3" align="left"><img src="images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
13 cdf0e10cSrcweir  </tr>
14 cdf0e10cSrcweir  <tr>
15 cdf0e10cSrcweir    <td colspan="3"><img  class="nothing10" src="images/nada.gif"></td>
16 cdf0e10cSrcweir  </tr>
17 cdf0e10cSrcweir  <tr>
18 cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
19 cdf0e10cSrcweir    <td>
20 cdf0e10cSrcweir      <table class="table2">
21 cdf0e10cSrcweir	    <tr>
22 cdf0e10cSrcweir		  <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
23 cdf0e10cSrcweir        </tr>
24 cdf0e10cSrcweir        <tr>
25 cdf0e10cSrcweir          <td>
26 cdf0e10cSrcweir          <table class="table3">
27 cdf0e10cSrcweir		  <tr>
28 cdf0e10cSrcweir			<td colspan="2" class="head1">Installation Guide</td>
29 cdf0e10cSrcweir			<td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
30 cdf0e10cSrcweir		  </tr>
31 cdf0e10cSrcweir		  </table>
32 cdf0e10cSrcweir          </td>
33 cdf0e10cSrcweir        </tr>
34 cdf0e10cSrcweir		<tr>
35 cdf0e10cSrcweir          <td>
36 cdf0e10cSrcweir          <table class="table3">
37 cdf0e10cSrcweir		  <tr>
38 cdf0e10cSrcweir		  <td colspan="2">
39 *ef1ef8e6SJürgen Schmidt		  <p>The Apache OpenOffice %PRODUCT_RELEASE% SDK comes with a set of development tools, base
40 cdf0e10cSrcweir		  libraries, header files and helper class files that can be used to
41 *ef1ef8e6SJürgen Schmidt		  develop Java/C++ components, to embed the Apache OpenOffice %PRODUCT_RELEASE% application in
42 cdf0e10cSrcweir          your own programs, or to use the API (scripting or remote control the
43 cdf0e10cSrcweir		  office). For a complete working environment, we have some additional
44 cdf0e10cSrcweir		  requirements:</p>
45 cdf0e10cSrcweir		  </td>
46 cdf0e10cSrcweir		  </tr>
47 cdf0e10cSrcweir		  <tr valign="top">
48 *ef1ef8e6SJürgen Schmidt          <td><b>Apache OpenOffice %PRODUCT_RELEASE% installation</td>
49 cdf0e10cSrcweir          <td class="content80">The SDK works on top of an existing office
50 cdf0e10cSrcweir		  installation and uses the same libraries as the office installation.</td>
51 cdf0e10cSrcweir          </tr>
52 cdf0e10cSrcweir		  </tr>
53 cdf0e10cSrcweir		  <tr valign="middle">
54 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
55 cdf0e10cSrcweir          </tr>
56 cdf0e10cSrcweir		  <tr valign="top">
57 cdf0e10cSrcweir          <td><b>JDK (1.5 or higher)<b></td>
58 cdf0e10cSrcweir          <td class="content80">
59 cdf0e10cSrcweir		  <p>A JDK is necessary for developing Java components or applications. An appropriate Java SDK can be found on <a target="_blank" href="http://java.sun.com/products" title="link to the Java SDK download page (online)">http://java.sun.com/products</a>.</p>
60 cdf0e10cSrcweir		  <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p>
61 cdf0e10cSrcweir		  <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td>
62 cdf0e10cSrcweir          </tr>
63 cdf0e10cSrcweir		  <tr valign="middle">
64 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
65 cdf0e10cSrcweir          </tr>
66 cdf0e10cSrcweir		  <tr valign="top">
67 cdf0e10cSrcweir          <td><b>C++ compiler<b></td>
68 cdf0e10cSrcweir          <td class="content80">A C++ compiler is necessary for developing C++
69 cdf0e10cSrcweir		  components or applications. UNO depends on a compiler dependent language
70 cdf0e10cSrcweir		  binding, so that we use the appropriate compiler where a language binding
71 cdf0e10cSrcweir		  exists:
72 cdf0e10cSrcweir		  <table class="table4">
73 cdf0e10cSrcweir		  <tr>
74 cdf0e10cSrcweir		  <td class="cell15">Solaris</td>
75 cdf0e10cSrcweir		  <td class="cell85">Sun Studion 8 (20070730)</td>
76 cdf0e10cSrcweir		  </tr>
77 cdf0e10cSrcweir		  <tr>
78 cdf0e10cSrcweir		  <td class="cell15">Linux</td>
79 cdf0e10cSrcweir		  <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td>
80 cdf0e10cSrcweir		  </tr>
81 cdf0e10cSrcweir		  <tr>
82 cdf0e10cSrcweir		  <td class="cell15">Windows</td>
83 cdf0e10cSrcweir		  <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td>
84 cdf0e10cSrcweir		  </tr>
85 cdf0e10cSrcweir		  </table>
86 cdf0e10cSrcweir		  <p><b>Note</b>: The C++ compiler is <b><u>optional</u></b>! If you use the Express edition you have to ensure that the <a href="http://www.microsoft.com/downloads/details.aspx?familyid=9B2DA534-3E03-4391-8A4D-074B9F2BC1BF&displaylang=en">Microsoft Visual Studio 2008 Redistributable Package</a> is also installed. You can download this package from Microsoft directly.</a></p></td>
87 cdf0e10cSrcweir          </tr>
88 cdf0e10cSrcweir		  <tr valign="middle">
89 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
90 cdf0e10cSrcweir          </tr>
91 cdf0e10cSrcweir		  <tr valign="top">
92 cdf0e10cSrcweir          <td><b>Microsoft .NET Framework SDK version 1.0 or higher<b></td>
93 cdf0e10cSrcweir          <td class="content80">The SDK is required for building CLI applications.
94 cdf0e10cSrcweir		  That is, programs written in languages, such as C# or VB.NET.<br>
95 cdf0e10cSrcweir		  <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td>
96 cdf0e10cSrcweir          </tr>
97 cdf0e10cSrcweir		  <tr valign="middle">
98 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
99 cdf0e10cSrcweir          </tr>
100 cdf0e10cSrcweir		  <tr valign="top">
101 cdf0e10cSrcweir          <td><b>GNU make (3.79.1 or higher)<b></td>
102 cdf0e10cSrcweir          <td class="content80">
103 cdf0e10cSrcweir		  <p>GNU make is used to build the examples of the SDK. GNU make is available from <a target="_blank" href="http://www.gnu.org" title="link to www.gnu.org (online)">http://www.gnu.org</a>. It can be ftped via <a target="_blank" href="ftp://ftp.gnu.org/gnu/make" title="link to gnumake on www.gnu.org (online)">ftp://ftp.gnu.org/gnu/make</a></p>
104 cdf0e10cSrcweir		  <p><b>Note</b>: Windows user can find an executable of gnu make under <a target="_blank" href="http://www.mingw.org/wiki/Getting_Started" title="link to the MinGW Getting Started wiki (online)">http://www.mingw.org/wiki/Getting_Started</a> (see the mingw32-make link under &quot;Manual Installation&quot;). Do not use the Cygwin make, because it does not
105 cdf0e10cSrcweir		  work well. On Solaris gnu make can be found often under <b><i>/usr/sfw/bin/gmake</i></b>, but keep in mind that you have to use <b>'gmake'</b> then. Or you can find gnu make also under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a>.</td>
106 cdf0e10cSrcweir          </tr>
107 cdf0e10cSrcweir		  <tr valign="middle">
108 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
109 cdf0e10cSrcweir          </tr>
110 cdf0e10cSrcweir		  <tr valign="top">
111 cdf0e10cSrcweir          <td><b>zip tool (2.3 or higher)<b></td>
112 cdf0e10cSrcweir          <td class="content80">The zip tool is used to create UNO packages. zip is
113 cdf0e10cSrcweir		  a new requirement to make the SDK independent of a Java SDK.<br>
114 cdf0e10cSrcweir		  If you do not have these already, you can download them from <a target="_blank" href="http://www.info-zip.org" title="link to www.ubfi-zip.org (online)">http://www.info-zip.org</a>. Note: The cygwin zip.exe does not work for the build under
115 cdf0e10cSrcweir		  the 4NT shell. You have to use the native w32 version.</td>
116 cdf0e10cSrcweir          </tr>
117 cdf0e10cSrcweir		  <tr valign="middle">
118 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
119 cdf0e10cSrcweir          </tr>
120 cdf0e10cSrcweir		  <tr>
121 cdf0e10cSrcweir		    <td><img class="nothing10" src="images/nada.gif"></td>
122 cdf0e10cSrcweir			<td align="right">
123 cdf0e10cSrcweir			<a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
124 cdf0e10cSrcweir			<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
125 cdf0e10cSrcweir		  </tr>
126 cdf0e10cSrcweir		  <tr valign="middle">
127 cdf0e10cSrcweir          <td colspan="2">
128 cdf0e10cSrcweir		  <p>The SDK provides an implicit configuration mechanism, which
129 cdf0e10cSrcweir		  configures the SDK build environment to your personal needs the first
130 cdf0e10cSrcweir		  time you use the SDK environment. This configuration step creates one or
131 cdf0e10cSrcweir		  two new setsdkenv_XXX scripts in the user's home directory:</P>
132 cdf0e10cSrcweir		  <ul>
133 cdf0e10cSrcweir		    <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b> and <b>$HOME/$OO_SDK_NAME/setsdkenv_unix.csh</b>&nbsp;&nbsp;-> for Unix
134 cdf0e10cSrcweir            <li><b>C:\Documents and Settings\&lt;username&gt;\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat</b></a>&nbsp;&nbsp;-> for Windows2000/XP or later
135 cdf0e10cSrcweir          </ul>
136 cdf0e10cSrcweir		  <p>The automatically started configure script (Unix and Windows2000/XP)
137 *ef1ef8e6SJürgen Schmidt		  requests relevant information and directories (SDK, the Office, GNU make,
138 cdf0e10cSrcweir		  Java, C++), in order to prepare a working SDK environment. After completing the
139 cdf0e10cSrcweir		  configure script once, the newly created script is always used to set the
140 cdf0e10cSrcweir		  necessary environment variables for using the SDK and the required
141 cdf0e10cSrcweir		  tools.</P>
142 cdf0e10cSrcweir		  <p>On UNIX operating systems, the configure script uses Perl. LINUX systems should have
143 cdf0e10cSrcweir		  installed a working Perl version, and on Solaris you can find a working
144 cdf0e10cSrcweir		  Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if
145 cdf0e10cSrcweir		  necessary. On Windows, the configure script uses Windows Script and
146 cdf0e10cSrcweir		  a JScipt. If you have problems with Windows Script, you can download a
147 cdf0e10cSrcweir		  newer version of <a href ="http://www.microsoft.com/downloads/details.aspx?FamilyId=C717D943-7E4B-4622-86EB-95A22B832CAA&displaylang=en" link"link to the download page for the Windows Script">Windows Script</a>.
148 cdf0e10cSrcweir          </p>
149 cdf0e10cSrcweir          <p>On other versions of Windows, use the batch
150 cdf0e10cSrcweir		  file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
151 cdf0e10cSrcweir		  rename it to *.bat, and adapt it to your local environment.</p>
152 cdf0e10cSrcweir		  <p>If you use the template batch file, edit and set
153 cdf0e10cSrcweir		  the following variables:</p>
154 cdf0e10cSrcweir		  <table class="table4">
155 cdf0e10cSrcweir		  <tr valign="top">
156 cdf0e10cSrcweir		  <td class="cell20"><b>OFFICE_HOME</b></td>
157 *ef1ef8e6SJürgen Schmidt		  <td class="cell80">Path to an existing Apache OpenOffice
158 *ef1ef8e6SJürgen Schmidt		  base installation, e.g. &quot;/opt/openoffice.org3&quot;. Be sure
159 cdf0e10cSrcweir		  that it is not a user installation only. Exactly one of OFFICE_HOME
160 cdf0e10cSrcweir          and OO_SDK_URE_HOME must be set. The other should be either unset or
161 cdf0e10cSrcweir          set to an empty value.</td>
162 cdf0e10cSrcweir		  </tr>
163 cdf0e10cSrcweir          <tr><a name="oosdkname"/>
164 cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_NAME</b></td>
165 cdf0e10cSrcweir          <td class="cell80">The configuration uses the
166 cdf0e10cSrcweir		  directory name of the SDK, but you can use another name as well.
167 cdf0e10cSrcweir		  It is important that the name does not contain spaces, because of a limitation
168 cdf0e10cSrcweir		  of gnu make which cannot handle spaces correctly. This name is, for
169 cdf0e10cSrcweir		  example, used to create an output directory in the users home directory
170 cdf0e10cSrcweir		  for any generated output when you use the SDK build environment.</td>
171 cdf0e10cSrcweir          </tr>
172 cdf0e10cSrcweir          <tr>
173 cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_URE_HOME</b></td>
174 cdf0e10cSrcweir          <td class="cell80">Path to an existing UNO Runtime Environment
175 cdf0e10cSrcweir          installation, e.g. &quot;/opt/openoffice.org/ure&quot;. Exactly one of
176 cdf0e10cSrcweir          OFFICE_HOME and OO_SDK_URE_HOME must be set. The other should be
177 cdf0e10cSrcweir          either unset or set to an empty value.</td>
178 cdf0e10cSrcweir          </tr>
179 cdf0e10cSrcweir		  <tr>
180 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_HOME</b></td>
181 cdf0e10cSrcweir		  <td class="cell80">Path to the SDK root directory, e.g.
182 cdf0e10cSrcweir		  &quot;/usr/local/StarOffice8_SDK&quot;</td>
183 cdf0e10cSrcweir		  </tr>
184 cdf0e10cSrcweir		  <tr>
185 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
186 cdf0e10cSrcweir		  <td class="cell80">Path to a JDK root directory. The JDK is
187 cdf0e10cSrcweir		  <b>optional</b> and only necessary if you like to run the Java examples
188 cdf0e10cSrcweir		  or if you like to use the SDK environment to develop your own Java
189 cdf0e10cSrcweir		  solution.</td>
190 cdf0e10cSrcweir		  </tr>
191 cdf0e10cSrcweir		  <tr>
192 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_CPP_HOME</b></td>
193 cdf0e10cSrcweir		  <td class="cell80">Path to the C++ compiler (on Windows, the directory
194 cdf0e10cSrcweir		  where the &quot;<i>vcvar32.bat</i>&quot; file can be found). The C++
195 cdf0e10cSrcweir		  compiler is <b>optional</b> and only necessary for building the C++
196 cdf0e10cSrcweir		  examples.</td>
197 cdf0e10cSrcweir		  </tr>
198 cdf0e10cSrcweir		  <tr>
199 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_CLI_HOME</b></td>
200 cdf0e10cSrcweir		  <td class="cell80">Path to the C# compiler and VB.NET compiler (on
201 cdf0e10cSrcweir		  Windows, this directory can be found under the system directory (e.g.
202 cdf0e10cSrcweir		  c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are
203 cdf0e10cSrcweir		  <b>optional</b> and only necessary for building the CLI examples.<br>
204 cdf0e10cSrcweir		  <b>Note: Windows only!</b></td>
205 cdf0e10cSrcweir		  </tr>
206 cdf0e10cSrcweir		  <tr>
207 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td>
208 cdf0e10cSrcweir		  <td class="cell80">Path to GNU make.</td>
209 cdf0e10cSrcweir		  </tr>
210 cdf0e10cSrcweir		  <tr>
211 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_ZIP_HOME</b></td>
212 cdf0e10cSrcweir		  <td class="cell80">Path to the 'zip' tool.</td>
213 cdf0e10cSrcweir		  </tr>
214 cdf0e10cSrcweir		  <tr>
215 cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
216 cdf0e10cSrcweir		  <td class="cell80">Path to an existing directory where the example output
217 cdf0e10cSrcweir		  is generated. The output directory is <b>optional</b>, by default
218 cdf0e10cSrcweir		  the output is generated in the SDK directory itself. If an output
219 cdf0e10cSrcweir		  directory is specified, the output is generated in a SDK dependent
220 cdf0e10cSrcweir		  subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
221 cdf0e10cSrcweir		  /OpenOffice.org %PRODUCT_RELEASE%/LINUXExample.out)</td>
222 cdf0e10cSrcweir		  </tr>
223 cdf0e10cSrcweir		  <tr>
224 cdf0e10cSrcweir		  <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
225 cdf0e10cSrcweir		  <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by
226 cdf0e10cSrcweir		  OFFICE_HOME. See also chapter <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">&quot;Extension Manager - unopkg&quot;</a> from the Developer's Guide.
227 cdf0e10cSrcweir          This variable is only relevant when OFFICE_HOME is set.</td>
228 cdf0e10cSrcweir		  </tr>
229 cdf0e10cSrcweir		  </table>
230 cdf0e10cSrcweir		  <p>You must run the <b>setsdkenv_XXX</b> script every time you want to
231 cdf0e10cSrcweir		  use the configured SDK environment. The settings are local for the current
232 cdf0e10cSrcweir		  shell on Windows or the new started shell on UNIX. On UNIX you
233 cdf0e10cSrcweir		  can now source one of the prepared environment
234 cdf0e10cSrcweir		  script files (&quot;setsdkenv_unix.sh&quot; or
235 cdf0e10cSrcweir		  &quot;setsdkenv_unix.csh&quot; dependending on the shell you use) to prepare
236 cdf0e10cSrcweir		  your current shell instead of starting a new shell.</p>
237 cdf0e10cSrcweir		  </td>
238 cdf0e10cSrcweir          </tr>
239 cdf0e10cSrcweir		  <tr valign="middle">
240 cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
241 cdf0e10cSrcweir          </tr>
242 cdf0e10cSrcweir		  <tr>
243 cdf0e10cSrcweir		    <td><img class="nothing10" src="images/nada.gif"></td>
244 cdf0e10cSrcweir			<td align="right">
245 cdf0e10cSrcweir			<a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
246 cdf0e10cSrcweir			<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
247 cdf0e10cSrcweir		  </tr>
248 cdf0e10cSrcweir		  <tr>
249 cdf0e10cSrcweir		  <td colspan="2">
250 cdf0e10cSrcweir		  <p class="head2">Manual Setting</p>
251 cdf0e10cSrcweir		  <p>If you do not want to use the script to set your working
252 cdf0e10cSrcweir		  environment, you must set the appropriate environment variables
253 cdf0e10cSrcweir		  yourself. The script sets the following environment variables:</p>
254 cdf0e10cSrcweir		  <p class="head3">Common Environment Variables</p>
255 cdf0e10cSrcweir		  <table class="table4">
256 cdf0e10cSrcweir          <tr valign="top">
257 cdf0e10cSrcweir          <td class="cell20">OO_SDK_NAME</td>
258 cdf0e10cSrcweir          <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
259 cdf0e10cSrcweir          </tr>
260 cdf0e10cSrcweir          <tr valign="top">
261 cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_BIN_DIR</td>
262 cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
263 cdf0e10cSrcweir          installation where binary executables are located (e.g.,
264 cdf0e10cSrcweir          <i>$OFFICE_HOME/program</i> for an office installation, or
265 cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/bin</i> for a Unix URE installation).</td>
266 cdf0e10cSrcweir          </tr>
267 cdf0e10cSrcweir          <tr valign="top">
268 cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_LIB_DIR</td>
269 cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
270 cdf0e10cSrcweir          installation where dynamic libraries are located (e.g.,
271 cdf0e10cSrcweir          <i>$OFFICE_HOME/program</i> for an office installation, or
272 cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/lib</i> for a Unix URE installation).</td>
273 cdf0e10cSrcweir          </tr>
274 cdf0e10cSrcweir          <tr valign="top">
275 cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_JAVA_DIR</td>
276 cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
277 cdf0e10cSrcweir          installation where Java JARs are located (e.g.,
278 cdf0e10cSrcweir          <i>$OFFICE_HOME/program/classes</i> for an office installation, or
279 cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/share/java</i> for a Unix URE installation).</td>
280 cdf0e10cSrcweir          </tr>
281 cdf0e10cSrcweir		  <tr valign="top">
282 cdf0e10cSrcweir		  <td class="cell20">CLASSPATH</td>
283 cdf0e10cSrcweir		  <td class="cell80">
284 cdf0e10cSrcweir          =<i>$OO_SDK_URE_JAVA_DIR/juh.jar;
285 cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/jurt.jar;
286 cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/ridl.jar;
287 cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/unoloader.jar;
288 cdf0e10cSrcweir              [$OO_SDK_URE_JAVA_DIR/unoil.jar;]
289 cdf0e10cSrcweir              $CLASSPATH</i><br>
290 cdf0e10cSrcweir          <p>The classpath will be set or extended to the necessary jar files of
291 cdf0e10cSrcweir		  the specified office installation. (<i>unoil.jar</i> is only included
292 cdf0e10cSrcweir          when OFFICE_HOME is set.)</p>
293 cdf0e10cSrcweir		  </td>
294 cdf0e10cSrcweir		  </tr>
295 cdf0e10cSrcweir		  <tr valign="top">
296 cdf0e10cSrcweir		  <td class="cell20">OFFICE_PROGRAM_PATH</td>
297 cdf0e10cSrcweir		  <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
298 cdf0e10cSrcweir		  <p>This variable is used to find, for example, the office type library and
299 cdf0e10cSrcweir		  the UNO package deployment tool. This variable is only relevant when
300 cdf0e10cSrcweir          OFFICE_HOME is set.</p>
301 cdf0e10cSrcweir		  </td>
302 cdf0e10cSrcweir		  </tr>
303 cdf0e10cSrcweir		  <tr valign="top">
304 cdf0e10cSrcweir		  <td class="cell20">UNO_PATH</td>
305 cdf0e10cSrcweir		  <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
306 cdf0e10cSrcweir          <p>This variable is used to ensure that the new C++ UNO bootstrap
307 cdf0e10cSrcweir		  mechanism uses the configured office installation of the SDK. Normally
308 cdf0e10cSrcweir		  the bootstrap mechanism finds the default office installation for the
309 cdf0e10cSrcweir		  user on the system. This variable is optional but is set from the scripts
310 cdf0e10cSrcweir		  to ensure a homogeneous environment. Especially useful during development
311 cdf0e10cSrcweir		  where you might have more than one office installation installed. This
312 cdf0e10cSrcweir          variable is only relevant when OFFICE_HOME is set.</p>
313 cdf0e10cSrcweir		  </td>
314 cdf0e10cSrcweir		  </tr>
315 cdf0e10cSrcweir		  </table>
316 cdf0e10cSrcweir		  <p class="head3">Environment Variables for UNIX</p>
317 cdf0e10cSrcweir		  <p class="head4">Solaris</p>
318 cdf0e10cSrcweir		  <table class="table4">
319 cdf0e10cSrcweir		  <tr valign="top">
320 cdf0e10cSrcweir		  <td class="cell20">LD_LIBRARY_PATH</td>
321 cdf0e10cSrcweir		  <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
322 cdf0e10cSrcweir		  <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
323 cdf0e10cSrcweir		  library path, the platform dependent lib directory for several additional
324 cdf0e10cSrcweir		  libraries.</p>
325 cdf0e10cSrcweir		  </td>
326 cdf0e10cSrcweir		  </tr>
327 cdf0e10cSrcweir		  <tr valign="top">
328 cdf0e10cSrcweir		  <td class="cell20">PATH</td>
329 cdf0e10cSrcweir		  <td class="cell80">=<i>$OO_SDK_HOME/(solsparc|solintel)/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH</i></b><br>
330 cdf0e10cSrcweir          <p>The PATH variable will be extended by the paths for the SDK development
331 cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
332 cdf0e10cSrcweir		  OO_SDK_URE_BIN_DIR, where the compiler or the JDK are
333 cdf0e10cSrcweir		  optional.</p>
334 cdf0e10cSrcweir		  </td>
335 cdf0e10cSrcweir		  </tr>
336 cdf0e10cSrcweir          <tr>
337 cdf0e10cSrcweir          <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
338 cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
339 cdf0e10cSrcweir          the URE in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
340 cdf0e10cSrcweir          needed for linking.</td>
341 cdf0e10cSrcweir          </tr>
342 cdf0e10cSrcweir		  </table>
343 cdf0e10cSrcweir		  <p class="head4">Linux</p>
344 cdf0e10cSrcweir		  <table class="table4">
345 cdf0e10cSrcweir		  <tr valign="top">
346 cdf0e10cSrcweir		  <td class="cell20">LD_LIBRARY_PATH</td>
347 cdf0e10cSrcweir		  <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
348 cdf0e10cSrcweir		  <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
349 cdf0e10cSrcweir		  library path, the platform dependent lib directory for some additional
350 cdf0e10cSrcweir		  libraries.</p>
351 cdf0e10cSrcweir		  </td>
352 cdf0e10cSrcweir		  </tr>
353 cdf0e10cSrcweir		  <tr valign="top">
354 cdf0e10cSrcweir		  <td class="cell20">PATH</td>
355 cdf0e10cSrcweir		  <td class="cell80">=<i>$OO_SDK_HOME/linux/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH</i><br>
356 cdf0e10cSrcweir		  <p>The PATH variable will be extended by the paths for the SDK development
357 cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
358 cdf0e10cSrcweir		  OO_SDK_URE_BIN_DIR, where the compiler and the JDK are
359 cdf0e10cSrcweir		  optional.</p>
360 cdf0e10cSrcweir		  </td>
361 cdf0e10cSrcweir		  </tr>
362 cdf0e10cSrcweir          <tr>
363 cdf0e10cSrcweir          <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
364 cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
365 cdf0e10cSrcweir          the URE in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
366 cdf0e10cSrcweir          linking.</td>
367 cdf0e10cSrcweir          </tr>
368 cdf0e10cSrcweir		  </table>
369 cdf0e10cSrcweir		  <p class="head3">Environment Variables for Windows</p>
370 cdf0e10cSrcweir		  <table class="table4">
371 cdf0e10cSrcweir		  <tr valign="top">
372 cdf0e10cSrcweir		  <td class="cell20">PATH</td>
373 cdf0e10cSrcweir		  <td class="cell80">=<i>%OO_SDK_HOME%\windows\bin; %OO_SDK_MAKE_HOME%; %OO_SDK_ZIP_HOME%; [%OO_SDK_CLI_HOME%;] [%OO_SDK_CPP_HOME%;] [%OO_SDK_JAVA_HOME%\bin;] %OO_SDK_URE_BIN_DIR%; %PATH%</i><br>
374 cdf0e10cSrcweir		  <p>The PATH variable will be extended by the paths for the SDK development
375 cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
376 cdf0e10cSrcweir		  OO_SDK_URE_BIN_DIR.</p>
377 cdf0e10cSrcweir		  </td>
378 cdf0e10cSrcweir		  </tr>
379 cdf0e10cSrcweir		  <tr valign="top">
380 cdf0e10cSrcweir		  <td class="cell20">LIB</td>
381 cdf0e10cSrcweir		  <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
382 cdf0e10cSrcweir		  <p>The LIB variable will be extended by the path to the import libraries
383 cdf0e10cSrcweir		  that are necessary for Windows.</p>
384 cdf0e10cSrcweir		  </td>
385 cdf0e10cSrcweir		  </tr>
386 cdf0e10cSrcweir		  <tr valign="top">
387 cdf0e10cSrcweir		  <td colspan="2" class="cell80">In addition to setting these environment
388 cdf0e10cSrcweir		  variables, the script calls the &quot;<i>vcvar32.bat</i>&quot; batch file
389 cdf0e10cSrcweir		  which is provided by the Microsoft Developer Studio to set the necessary
390 cdf0e10cSrcweir		  environment variables for the compiler.</td>
391 cdf0e10cSrcweir		  </tr>
392 cdf0e10cSrcweir		  </table>
393 cdf0e10cSrcweir		  </td>
394 cdf0e10cSrcweir		  </tr>
395 cdf0e10cSrcweir		  </table>
396 cdf0e10cSrcweir          </td>
397 cdf0e10cSrcweir		</tr>
398 cdf0e10cSrcweir	  </table>
399 cdf0e10cSrcweir	</td>
400 cdf0e10cSrcweir  </tr>
401 cdf0e10cSrcweir  <tr>
402 cdf0e10cSrcweir    <td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
403 cdf0e10cSrcweir  </tr>
404 cdf0e10cSrcweir  <tr>
405 cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
406 cdf0e10cSrcweir  </tr>
407 cdf0e10cSrcweir  <tr>
408 cdf0e10cSrcweir    <td colspan="3">
409 cdf0e10cSrcweir      <div class="centertext">
410 *ef1ef8e6SJürgen Schmidt	<p><img class="apachelogo" src="images/odk-footer-logo.gif" title="Apache Feather" alt="Apache Feather" />
411 *ef1ef8e6SJürgen Schmidt            Copyright &copy; 2011 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOfifce.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.<p>
412 cdf0e10cSrcweir      </div>
413 cdf0e10cSrcweir    </td>
414 cdf0e10cSrcweir  </tr>
415 cdf0e10cSrcweir</table>
416 cdf0e10cSrcweir<map name="Map">
417 *ef1ef8e6SJürgen Schmidt  <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
418 cdf0e10cSrcweir</map>
419 cdf0e10cSrcweir</body>
420 cdf0e10cSrcweir</html>
421