install.html (599cc5b4) install.html (ed9d7cbe)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
4#
5# Licensed to the Apache Software Foundation (ASF) under one
6# or more contributor license agreements. See the NOTICE file
7# distributed with this work for additional information
8# regarding copyright ownership. The ASF licenses this file

--- 136 unchanged lines hidden (view full) ---

145 <td class="content80">The cat and set tools are used to create some extensions.
146 <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
147 <a target="_blank" href="http://sourceforge.net/projects/unxutils/files/latest/downloadg" title="link to UnxUtils (online)">http://sourceforge.net/projects/unxutils/files/latest/download</a>.</p>
148 </td>
149 </tr>
150 <tr valign="middle">
151 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
152 </tr>
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
4#
5# Licensed to the Apache Software Foundation (ASF) under one
6# or more contributor license agreements. See the NOTICE file
7# distributed with this work for additional information
8# regarding copyright ownership. The ASF licenses this file

--- 136 unchanged lines hidden (view full) ---

145 <td class="content80">The cat and set tools are used to create some extensions.
146 <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
147 <a target="_blank" href="http://sourceforge.net/projects/unxutils/files/latest/downloadg" title="link to UnxUtils (online)">http://sourceforge.net/projects/unxutils/files/latest/download</a>.</p>
148 </td>
149 </tr>
150 <tr valign="middle">
151 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
152 </tr>
153 <td><b>Boost (<b>Unix only</b> and optional)<b></td>
154 <td class="content80">The boost library is used today on Unix systems as replacement for the stlport library. The stlport library is removed and replaced by either the compiler stl (on Windows) or the boost stl on all Unix based systems. We are planning to switch to the compiler stl completely as soon as possible. The boost headers/library are <b>optional</b> and for C++ development only if stl containers are used.
155 <p><b>Download:</b> <a target="_blank" href="http://sourceforge.net/projects/boost/files/boost/1.48.0/boost_1_48_0.tar.bz2/download" title="link to boost version 1.48.0 (online)">http://sourceforge.net/projects/boost/files/boost/1.48.0/boost_1_48_0.tar.bz2/download</a>.</p>
156 </td>
157 <tr valign="middle">
158 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
159 </tr>
153 <tr>
154 <td><img class="nothing10" src="images/nada.gif"></td>
155 <td align="right">
156 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
157 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
158 </tr>
159 <tr valign="middle">
160 <td colspan="2">

--- 22 unchanged lines hidden (view full) ---

183 file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
184 rename it to *.bat, and adapt it to your local environment.</p>
185 <p>If you use the template batch file, edit and set
186 the following variables:</p>
187 <table class="table4">
188 <tr valign="top">
189 <td class="cell20"><b>OFFICE_HOME</b></td>
190 <td class="cell80">Path to an existing Apache OpenOffice
160 <tr>
161 <td><img class="nothing10" src="images/nada.gif"></td>
162 <td align="right">
163 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
164 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
165 </tr>
166 <tr valign="middle">
167 <td colspan="2">

--- 22 unchanged lines hidden (view full) ---

190 file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
191 rename it to *.bat, and adapt it to your local environment.</p>
192 <p>If you use the template batch file, edit and set
193 the following variables:</p>
194 <table class="table4">
195 <tr valign="top">
196 <td class="cell20"><b>OFFICE_HOME</b></td>
197 <td class="cell80">Path to an existing Apache OpenOffice
191 base installation, e.g. &quot;/opt/openoffice3&quot;. Be sure
192 that it is not a user installation only. Exactly one of OFFICE_HOME
193 and OO_SDK_URE_HOME must be set. The other should be either unset or
194 set to an empty value.</td>
198 installation, e.g. &quot;/opt/openoffice4&quot;. Be sure
199 that it is not a user installation only.</td>
195 </tr>
196 <tr><a name="oosdkname"/>
197 <td class="cell20"><b>OO_SDK_NAME</b></td>
198 <td class="cell80">The configuration uses the
199 directory name of the SDK, but you can use another name as well.
200 It is important that the name does not contain spaces, because of a limitation
201 of gnu make which cannot handle spaces correctly. This name is, for
202 example, used to create an output directory in the users home directory
203 for any generated output when you use the SDK build environment.</td>
204 </tr>
200 </tr>
201 <tr><a name="oosdkname"/>
202 <td class="cell20"><b>OO_SDK_NAME</b></td>
203 <td class="cell80">The configuration uses the
204 directory name of the SDK, but you can use another name as well.
205 It is important that the name does not contain spaces, because of a limitation
206 of gnu make which cannot handle spaces correctly. This name is, for
207 example, used to create an output directory in the users home directory
208 for any generated output when you use the SDK build environment.</td>
209 </tr>
205 <tr>
206 <td class="cell20"><b>OO_SDK_URE_HOME</b></td>
207 <td class="cell80">Path to an existing UNO Runtime Environment
208 installation, e.g. &quot;/opt/openoffice/ure&quot;. Exactly one of
209 OFFICE_HOME and OO_SDK_URE_HOME must be set. The other should be
210 either unset or set to an empty value.</td>
211 </tr>
212 <tr>
213 <td class="cell20"><b>OO_SDK_HOME</b></td>
214 <td class="cell80">Path to the SDK root directory, e.g.
215 &quot;/usr/local/StarOffice8_SDK&quot;</td>
216 </tr>
217 <tr>
218 <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
219 <td class="cell80">Path to a JDK root directory. The JDK is

--- 27 unchanged lines hidden (view full) ---

247 <tr>
248 <td class="cell20"><b>OO_SDK_CAT_HOME</b></td>
249 <td class="cell80">Path to the 'cat' tool.</td>
250 </tr>
251 <tr>
252 <td class="cell20"><b>OO_SDK_SED_HOME</b></td>
253 <td class="cell80">Path to the 'sed' tool.</td>
254 </tr>
210 <tr>
211 <td class="cell20"><b>OO_SDK_HOME</b></td>
212 <td class="cell80">Path to the SDK root directory, e.g.
213 &quot;/usr/local/StarOffice8_SDK&quot;</td>
214 </tr>
215 <tr>
216 <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
217 <td class="cell80">Path to a JDK root directory. The JDK is

--- 27 unchanged lines hidden (view full) ---

245 <tr>
246 <td class="cell20"><b>OO_SDK_CAT_HOME</b></td>
247 <td class="cell80">Path to the 'cat' tool.</td>
248 </tr>
249 <tr>
250 <td class="cell20"><b>OO_SDK_SED_HOME</b></td>
251 <td class="cell80">Path to the 'sed' tool.</td>
252 </tr>
253 <tr>
254 <td class="cell20"><b>OO_SDK_BOOST_HOME</b></td>
255 <td class="cell80">Path to a boost installation, this is optional for C++ and Unix only.</td>
256 </tr>
255 <tr>
256 <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
257 <td class="cell80">Path to an existing directory where the example output
258 is generated. The output directory is <b>optional</b>, by default
259 the output is generated in the SDK directory itself. If an output
260 directory is specified, the output is generated in a SDK dependent
261 subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
262 /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>

--- 31 unchanged lines hidden (view full) ---

294 yourself. The script sets the following environment variables:</p>
295 <p class="head3">Common Environment Variables</p>
296 <table class="table4">
297 <tr valign="top">
298 <td class="cell20">OO_SDK_NAME</td>
299 <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
300 </tr>
301 <tr valign="top">
257 <tr>
258 <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
259 <td class="cell80">Path to an existing directory where the example output
260 is generated. The output directory is <b>optional</b>, by default
261 the output is generated in the SDK directory itself. If an output
262 directory is specified, the output is generated in a SDK dependent
263 subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
264 /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>

--- 31 unchanged lines hidden (view full) ---

296 yourself. The script sets the following environment variables:</p>
297 <p class="head3">Common Environment Variables</p>
298 <table class="table4">
299 <tr valign="top">
300 <td class="cell20">OO_SDK_NAME</td>
301 <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
302 </tr>
303 <tr valign="top">
302 <td class="cell20">OO_SDK_URE_BIN_DIR</td>
303 <td class="cell80">The path within the chosen office or URE
304 installation where binary executables are located (e.g.,
305 <i>$OFFICE_HOME/program</i> for an office installation, or
306 <i>$OO_SDK_URE_HOME/bin</i> for a Unix URE installation).</td>
304 <td class="cell20">OO_SDK_OFFICE_BIN_DIR</td>
305 <td class="cell80">The path to the program directory in the office installation (e.g. <i>$OFFICE_HOME/program</i>).</td>
307 </tr>
308 <tr valign="top">
306 </tr>
307 <tr valign="top">
309 <td class="cell20">OO_SDK_URE_LIB_DIR</td>
310 <td class="cell80">The path within the chosen office or URE
311 installation where dynamic libraries are located (e.g.,
312 <i>$OFFICE_HOME/program</i> for an office installation, or
313 <i>$OO_SDK_URE_HOME/lib</i> for a Unix URE installation).</td>
308 <td class="cell20">OO_SDK_OFFICE_LIB_DIR</td>
309 <td class="cell80">The path to the office program directory in the office installtion (e.g. <i>$OFFICE_HOME/program</i>).</td>
314 </tr>
315 <tr valign="top">
310 </tr>
311 <tr valign="top">
316 <td class="cell20">OO_SDK_URE_JAVA_DIR</td>
317 <td class="cell80">The path within the chosen office or URE
318 installation where Java JARs are located (e.g.,
319 <i>$OFFICE_HOME/program/classes</i> for an office installation, or
320 <i>$OO_SDK_URE_HOME/share/java</i> for a Unix URE installation).</td>
312 <td class="cell20">OO_SDK_OFFICE_JAVA_DIR</td>
313 <td class="cell80">The path to the classes direcgtory in the office program directory where Java JARs are located (e.g.
314 <i>$OFFICE_HOME/program/classes</i>).</td>
321 </tr>
322 <tr valign="top">
323 <td class="cell20">CLASSPATH</td>
324 <td class="cell80">
315 </tr>
316 <tr valign="top">
317 <td class="cell20">CLASSPATH</td>
318 <td class="cell80">
325 =<i>$OO_SDK_URE_JAVA_DIR/juh.jar;
326 $OO_SDK_URE_JAVA_DIR/jurt.jar;
327 $OO_SDK_URE_JAVA_DIR/ridl.jar;
328 $OO_SDK_URE_JAVA_DIR/unoloader.jar;
329 [$OO_SDK_URE_JAVA_DIR/unoil.jar;]
319 =<i>$OO_SDK_OFFICE_JAVA_DIR/juh.jar;
320 $OO_SDK_OFFICE_JAVA_DIR/jurt.jar;
321 $OO_SDK_OFFICE_JAVA_DIR/ridl.jar;
322 $OO_SDK_OFFICE_JAVA_DIR/unoloader.jar;
323 [$OO_SDK_OFFICE_JAVA_DIR/unoil.jar;]
330 $CLASSPATH</i><br>
331 <p>The classpath will be set or extended to the necessary jar files of
324 $CLASSPATH</i><br>
325 <p>The classpath will be set or extended to the necessary jar files of
332 the specified office installation. (<i>unoil.jar</i> is only included
333 when OFFICE_HOME is set.)</p>
326 the specified office installation.</p>
334 </td>
335 </tr>
336 <tr valign="top">
337 <td class="cell20">OFFICE_PROGRAM_PATH</td>
338 <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
339 <p>This variable is used to find, for example, the office type library and
327 </td>
328 </tr>
329 <tr valign="top">
330 <td class="cell20">OFFICE_PROGRAM_PATH</td>
331 <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
332 <p>This variable is used to find, for example, the office type library and
340 the UNO package deployment tool. This variable is only relevant when
341 OFFICE_HOME is set.</p>
333 the UNO package deployment tool.</p>
342 </td>
343 </tr>
344 <tr valign="top">
345 <td class="cell20">UNO_PATH</td>
346 <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
347 <p>This variable is used to ensure that the new C++ UNO bootstrap
348 mechanism uses the configured office installation of the SDK. Normally
349 the bootstrap mechanism finds the default office installation for the
350 user on the system. This variable is optional but is set from the scripts
351 to ensure a homogeneous environment. Especially useful during development
334 </td>
335 </tr>
336 <tr valign="top">
337 <td class="cell20">UNO_PATH</td>
338 <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
339 <p>This variable is used to ensure that the new C++ UNO bootstrap
340 mechanism uses the configured office installation of the SDK. Normally
341 the bootstrap mechanism finds the default office installation for the
342 user on the system. This variable is optional but is set from the scripts
343 to ensure a homogeneous environment. Especially useful during development
352 where you might have more than one office installation installed. This
353 variable is only relevant when OFFICE_HOME is set.</p>
344 where you might have more than one office installation installed.</p>
354 </td>
355 </tr>
356 </table>
357 <p class="head3">Environment Variables for UNIX</p>
358 <p class="head4">Solaris</p>
359 <table class="table4">
360 <tr valign="top">
361 <td class="cell20">LD_LIBRARY_PATH</td>
345 </td>
346 </tr>
347 </table>
348 <p class="head3">Environment Variables for UNIX</p>
349 <p class="head4">Solaris</p>
350 <table class="table4">
351 <tr valign="top">
352 <td class="cell20">LD_LIBRARY_PATH</td>
362 <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
363 <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
353 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
354 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
364 library path, the platform dependent lib directory for several additional
365 libraries.</p>
366 </td>
367 </tr>
368 <tr valign="top">
369 <td class="cell20">PATH</td>
355 library path, the platform dependent lib directory for several additional
356 libraries.</p>
357 </td>
358 </tr>
359 <tr valign="top">
360 <td class="cell20">PATH</td>
370 <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>
361 <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_OFFICE_BIN_DIR: $PATH</i></b><br>
371 <p>The PATH variable will be extended by the paths for the SDK development
372 tools, the compiler, the JDK, GNU make, the zip tool and the
362 <p>The PATH variable will be extended by the paths for the SDK development
363 tools, the compiler, the JDK, GNU make, the zip tool and the
373 OO_SDK_URE_BIN_DIR, where the compiler or the JDK are
364 OO_SDK_OFFICE_BIN_DIR, where the compiler or the JDK are
374 optional.</p>
375 </td>
376 </tr>
377 <tr>
365 optional.</p>
366 </td>
367 </tr>
368 <tr>
378 <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
369 <td colspan="2" class="cell80"Based OFFICE_HOME, the script
379 additionally creates symbolic links to the public dynamic libraries of
370 additionally creates symbolic links to the public dynamic libraries of
380 the URE in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
371 the office UNO runtime in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
381 needed for linking.</td>
382 </tr>
383 </table>
384 <p class="head4">Linux</p>
385 <table class="table4">
386 <tr valign="top">
387 <td class="cell20">LD_LIBRARY_PATH</td>
372 needed for linking.</td>
373 </tr>
374 </table>
375 <p class="head4">Linux</p>
376 <table class="table4">
377 <tr valign="top">
378 <td class="cell20">LD_LIBRARY_PATH</td>
388 <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
389 <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
379 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
380 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
390 library path, the platform dependent lib directory for some additional
391 libraries.</p>
392 </td>
393 </tr>
394 <tr valign="top">
395 <td class="cell20">PATH</td>
381 library path, the platform dependent lib directory for some additional
382 libraries.</p>
383 </td>
384 </tr>
385 <tr valign="top">
386 <td class="cell20">PATH</td>
396 <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>
387 <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_OFFICE_BIN_DIR: $PATH</i><br>
397 <p>The PATH variable will be extended by the paths for the SDK development
398 tools, the compiler, the JDK, GNU make, the zip tool and the
388 <p>The PATH variable will be extended by the paths for the SDK development
389 tools, the compiler, the JDK, GNU make, the zip tool and the
399 OO_SDK_URE_BIN_DIR, where the compiler and the JDK are
390 OO_SDK_OFFICE_BIN_DIR, where the compiler and the JDK are
400 optional.</p>
401 </td>
402 </tr>
403 <tr>
391 optional.</p>
392 </td>
393 </tr>
394 <tr>
404 <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
395 <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
405 additionally creates symbolic links to the public dynamic libraries of
396 additionally creates symbolic links to the public dynamic libraries of
406 the URE in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
397 the office UNO runtime in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
407 linking.</td>
408 </tr>
409 </table>
410 <p class="head3">Environment Variables for Windows</p>
411 <table class="table4">
412 <tr valign="top">
413 <td class="cell20">PATH</td>
398 linking.</td>
399 </tr>
400 </table>
401 <p class="head3">Environment Variables for Windows</p>
402 <table class="table4">
403 <tr valign="top">
404 <td class="cell20">PATH</td>
414 <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>
405 <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_OFFICE_BIN_DIR%; %PATH%</i><br>
415 <p>The PATH variable will be extended by the paths for the SDK development
416 tools, the compiler, the JDK, GNU make, the zip tool and the
406 <p>The PATH variable will be extended by the paths for the SDK development
407 tools, the compiler, the JDK, GNU make, the zip tool and the
417 OO_SDK_URE_BIN_DIR.</p>
408 OO_SDK_OFFICE_BIN_DIR.</p>
418 </td>
419 </tr>
420 <tr valign="top">
421 <td class="cell20">LIB</td>
422 <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
423 <p>The LIB variable will be extended by the path to the import libraries
424 that are necessary for Windows.</p>
425 </td>

--- 36 unchanged lines hidden --- 		409 </td>
410 </tr>
411 <tr valign="top">
412 <td class="cell20">LIB</td>
413 <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
414 <p>The LIB variable will be extended by the path to the import libraries
415 that are necessary for Windows.</p>
416 </td>

--- 36 unchanged lines hidden ---