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