xref: /trunk/main/odk/docs/install.html (revision ff3f4ebc)
1122c3632SJürgen Schmidt<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2122c3632SJürgen Schmidt<!--
3122c3632SJürgen Schmidt#**************************************************************
4122c3632SJürgen Schmidt#
5122c3632SJürgen Schmidt#  Licensed to the Apache Software Foundation (ASF) under one
6122c3632SJürgen Schmidt#  or more contributor license agreements.  See the NOTICE file
7122c3632SJürgen Schmidt#  distributed with this work for additional information
8122c3632SJürgen Schmidt#  regarding copyright ownership.  The ASF licenses this file
9122c3632SJürgen Schmidt#  to you under the Apache License, Version 2.0 (the
10122c3632SJürgen Schmidt#  "License"); you may not use this file except in compliance
11122c3632SJürgen Schmidt#  with the License.  You may obtain a copy of the License at
12122c3632SJürgen Schmidt#
13122c3632SJürgen Schmidt#    http://www.apache.org/licenses/LICENSE-2.0
14122c3632SJürgen Schmidt#
15122c3632SJürgen Schmidt#  Unless required by applicable law or agreed to in writing,
16122c3632SJürgen Schmidt#  software distributed under the License is distributed on an
17122c3632SJürgen Schmidt#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18122c3632SJürgen Schmidt#  KIND, either express or implied.  See the License for the
19122c3632SJürgen Schmidt#  specific language governing permissions and limitations
20122c3632SJürgen Schmidt#  under the License.
21122c3632SJürgen Schmidt#
22122c3632SJürgen Schmidt#**************************************************************
23122c3632SJürgen Schmidt -->
24cdf0e10cSrcweir<html>
25cdf0e10cSrcweir<head>
26ef1ef8e6SJürgen Schmidt  <title>Apache OpenOffice %PRODUCT_RELEASE% SDK - Installation Guide</title>
27cdf0e10cSrcweir  <link rel="stylesheet" type="text/css" href="sdk_styles.css">
28cdf0e10cSrcweir  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
29cdf0e10cSrcweir  <meta name="author" content="J&uuml;rgen Schmidt">
30cdf0e10cSrcweir  <meta name="created" content="2004-12-14">
31cdf0e10cSrcweir</head>
32cdf0e10cSrcweir<body class="sdkbody"><a name="install"/>
33cdf0e10cSrcweir<table class="table1" cellpadding=0>
34cdf0e10cSrcweir  <tr style="background-image:url(images/sdk_head-2.png)">
35cdf0e10cSrcweir    <td colspan="3" align="left"><img src="images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
36cdf0e10cSrcweir  </tr>
37cdf0e10cSrcweir  <tr>
38cdf0e10cSrcweir    <td colspan="3"><img  class="nothing10" src="images/nada.gif"></td>
39cdf0e10cSrcweir  </tr>
40cdf0e10cSrcweir  <tr>
41cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
42cdf0e10cSrcweir    <td>
43cdf0e10cSrcweir      <table class="table2">
44cdf0e10cSrcweir        <tr>
45cdf0e10cSrcweir          <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
46cdf0e10cSrcweir        </tr>
47cdf0e10cSrcweir        <tr>
48cdf0e10cSrcweir          <td>
49cdf0e10cSrcweir          <table class="table3">
50cdf0e10cSrcweir          <tr>
51cdf0e10cSrcweir            <td colspan="2" class="head1">Installation Guide</td>
52cdf0e10cSrcweir            <td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
53cdf0e10cSrcweir          </tr>
54cdf0e10cSrcweir          </table>
55cdf0e10cSrcweir          </td>
56cdf0e10cSrcweir        </tr>
57cdf0e10cSrcweir        <tr>
58cdf0e10cSrcweir          <td>
59cdf0e10cSrcweir          <table class="table3">
60cdf0e10cSrcweir          <tr>
61cdf0e10cSrcweir          <td colspan="2">
62ef1ef8e6SJürgen Schmidt          <p>The Apache OpenOffice %PRODUCT_RELEASE% SDK comes with a set of development tools, base
63cdf0e10cSrcweir          libraries, header files and helper class files that can be used to
64ef1ef8e6SJürgen Schmidt          develop Java/C++ components, to embed the Apache OpenOffice %PRODUCT_RELEASE% application in
65cdf0e10cSrcweir          your own programs, or to use the API (scripting or remote control the
66cdf0e10cSrcweir          office). For a complete working environment, we have some additional
67cdf0e10cSrcweir          requirements:</p>
68cdf0e10cSrcweir          </td>
69cdf0e10cSrcweir          </tr>
70cdf0e10cSrcweir          <tr valign="top">
71ef1ef8e6SJürgen Schmidt          <td><b>Apache OpenOffice %PRODUCT_RELEASE% installation</td>
72cdf0e10cSrcweir          <td class="content80">The SDK works on top of an existing office
73cdf0e10cSrcweir          installation and uses the same libraries as the office installation.</td>
74cdf0e10cSrcweir          </tr>
75cdf0e10cSrcweir          </tr>
76cdf0e10cSrcweir          <tr valign="middle">
77cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
78cdf0e10cSrcweir          </tr>
79cdf0e10cSrcweir          <tr valign="top">
80cdf0e10cSrcweir          <td><b>JDK (1.5 or higher)<b></td>
81cdf0e10cSrcweir          <td class="content80">
82cdf0e10cSrcweir          <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>
83cdf0e10cSrcweir          <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p>
84cdf0e10cSrcweir          <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td>
85cdf0e10cSrcweir          </tr>
86cdf0e10cSrcweir          <tr valign="middle">
87cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
88cdf0e10cSrcweir          </tr>
89cdf0e10cSrcweir          <tr valign="top">
90cdf0e10cSrcweir          <td><b>C++ compiler<b></td>
91cdf0e10cSrcweir          <td class="content80">A C++ compiler is necessary for developing C++
92cdf0e10cSrcweir          components or applications. UNO depends on a compiler dependent language
93cdf0e10cSrcweir          binding, so that we use the appropriate compiler where a language binding
94cdf0e10cSrcweir          exists:
95cdf0e10cSrcweir          <table class="table4">
96cdf0e10cSrcweir          <tr>
97cdf0e10cSrcweir          <td class="cell15">Solaris</td>
98cdf0e10cSrcweir          <td class="cell85">Sun Studion 8 (20070730)</td>
99cdf0e10cSrcweir          </tr>
100cdf0e10cSrcweir          <tr>
101cdf0e10cSrcweir          <td class="cell15">Linux</td>
102cdf0e10cSrcweir          <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td>
103cdf0e10cSrcweir          </tr>
104cdf0e10cSrcweir          <tr>
105cdf0e10cSrcweir          <td class="cell15">Windows</td>
106cdf0e10cSrcweir          <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td>
107cdf0e10cSrcweir          </tr>
108cdf0e10cSrcweir          </table>
109cdf0e10cSrcweir          <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>
110cdf0e10cSrcweir          </tr>
111cdf0e10cSrcweir          <tr valign="middle">
112cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
113cdf0e10cSrcweir          </tr>
114cdf0e10cSrcweir          <tr valign="top">
115cdf0e10cSrcweir          <td><b>Microsoft .NET Framework SDK version 1.0 or higher<b></td>
116cdf0e10cSrcweir          <td class="content80">The SDK is required for building CLI applications.
117cdf0e10cSrcweir          That is, programs written in languages, such as C# or VB.NET.<br>
118cdf0e10cSrcweir          <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td>
119cdf0e10cSrcweir          </tr>
120cdf0e10cSrcweir          <tr valign="middle">
121cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
122cdf0e10cSrcweir          </tr>
123cdf0e10cSrcweir          <tr valign="top">
124cdf0e10cSrcweir          <td><b>GNU make (3.79.1 or higher)<b></td>
125cdf0e10cSrcweir          <td class="content80">
126cdf0e10cSrcweir          <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>
127cdf0e10cSrcweir          <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
128cdf0e10cSrcweir          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>
129cdf0e10cSrcweir          </tr>
130cdf0e10cSrcweir          <tr valign="middle">
131cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
132cdf0e10cSrcweir          </tr>
133cdf0e10cSrcweir          <tr valign="top">
134cdf0e10cSrcweir          <td><b>zip tool (2.3 or higher)<b></td>
135cdf0e10cSrcweir          <td class="content80">The zip tool is used to create UNO packages. zip is
136cdf0e10cSrcweir          a new requirement to make the SDK independent of a Java SDK.<br>
137cdf0e10cSrcweir          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
138cdf0e10cSrcweir          the 4NT shell. You have to use the native w32 version.</td>
139cdf0e10cSrcweir          </tr>
140cdf0e10cSrcweir          <tr valign="middle">
141cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
142cdf0e10cSrcweir          </tr>
143985d02c7SAriel Constenla-Haile          <tr valign="top">
144985d02c7SAriel Constenla-Haile          <td><b>cat and sed tools<b></td>
145985d02c7SAriel Constenla-Haile          <td class="content80">The cat and set tools are used to create some extensions.
146985d02c7SAriel Constenla-Haile          <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
147985d02c7SAriel Constenla-Haile          <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>
148985d02c7SAriel Constenla-Haile          </td>
149985d02c7SAriel Constenla-Haile          </tr>
150985d02c7SAriel Constenla-Haile          <tr valign="middle">
151985d02c7SAriel Constenla-Haile            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
152985d02c7SAriel Constenla-Haile          </tr>
153cdf0e10cSrcweir          <tr>
154cdf0e10cSrcweir            <td><img class="nothing10" src="images/nada.gif"></td>
155cdf0e10cSrcweir            <td align="right">
156cdf0e10cSrcweir            <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
157cdf0e10cSrcweir            <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
158cdf0e10cSrcweir          </tr>
159cdf0e10cSrcweir          <tr valign="middle">
160cdf0e10cSrcweir          <td colspan="2">
161cdf0e10cSrcweir          <p>The SDK provides an implicit configuration mechanism, which
162cdf0e10cSrcweir          configures the SDK build environment to your personal needs the first
163985d02c7SAriel Constenla-Haile          time you use the SDK environment. This configuration step creates a
164985d02c7SAriel Constenla-Haile          new setsdkenv_XXX script in the user's home directory:</P>
165cdf0e10cSrcweir          <ul>
166985d02c7SAriel Constenla-Haile            <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b>&nbsp;&nbsp;-> for Unix
167985d02c7SAriel Constenla-Haile            <li><b>C:\Documents and Settings\&lt;username&gt;\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat</b>&nbsp;&nbsp;-> for Windows2000/XP or later
168cdf0e10cSrcweir          </ul>
169cdf0e10cSrcweir          <p>The automatically started configure script (Unix and Windows2000/XP)
170ef1ef8e6SJürgen Schmidt          requests relevant information and directories (SDK, the Office, GNU make,
171cdf0e10cSrcweir          Java, C++), in order to prepare a working SDK environment. After completing the
172cdf0e10cSrcweir          configure script once, the newly created script is always used to set the
173cdf0e10cSrcweir          necessary environment variables for using the SDK and the required
174cdf0e10cSrcweir          tools.</P>
175cdf0e10cSrcweir          <p>On UNIX operating systems, the configure script uses Perl. LINUX systems should have
176cdf0e10cSrcweir          installed a working Perl version, and on Solaris you can find a working
177cdf0e10cSrcweir          Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if
178cdf0e10cSrcweir          necessary. On Windows, the configure script uses Windows Script and
179cdf0e10cSrcweir          a JScipt. If you have problems with Windows Script, you can download a
180cdf0e10cSrcweir          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>.
181cdf0e10cSrcweir          </p>
182cdf0e10cSrcweir          <p>On other versions of Windows, use the batch
183cdf0e10cSrcweir          file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
184cdf0e10cSrcweir          rename it to *.bat, and adapt it to your local environment.</p>
185cdf0e10cSrcweir          <p>If you use the template batch file, edit and set
186cdf0e10cSrcweir          the following variables:</p>
187cdf0e10cSrcweir          <table class="table4">
188cdf0e10cSrcweir          <tr valign="top">
189cdf0e10cSrcweir          <td class="cell20"><b>OFFICE_HOME</b></td>
190ef1ef8e6SJürgen Schmidt          <td class="cell80">Path to an existing Apache OpenOffice
191*ff3f4ebcSOliver-Rainer Wittmann          base installation, e.g. &quot;/opt/apacheopenoffice3&quot;. Be sure
192cdf0e10cSrcweir          that it is not a user installation only. Exactly one of OFFICE_HOME
193cdf0e10cSrcweir          and OO_SDK_URE_HOME must be set. The other should be either unset or
194cdf0e10cSrcweir          set to an empty value.</td>
195cdf0e10cSrcweir          </tr>
196cdf0e10cSrcweir          <tr><a name="oosdkname"/>
197cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_NAME</b></td>
198cdf0e10cSrcweir          <td class="cell80">The configuration uses the
199cdf0e10cSrcweir          directory name of the SDK, but you can use another name as well.
200cdf0e10cSrcweir          It is important that the name does not contain spaces, because of a limitation
201cdf0e10cSrcweir          of gnu make which cannot handle spaces correctly. This name is, for
202cdf0e10cSrcweir          example, used to create an output directory in the users home directory
203cdf0e10cSrcweir          for any generated output when you use the SDK build environment.</td>
204cdf0e10cSrcweir          </tr>
205cdf0e10cSrcweir          <tr>
206cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_URE_HOME</b></td>
207cdf0e10cSrcweir          <td class="cell80">Path to an existing UNO Runtime Environment
208*ff3f4ebcSOliver-Rainer Wittmann          installation, e.g. &quot;/opt/apacheopenoffice/ure&quot;. Exactly one of
209cdf0e10cSrcweir          OFFICE_HOME and OO_SDK_URE_HOME must be set. The other should be
210cdf0e10cSrcweir          either unset or set to an empty value.</td>
211cdf0e10cSrcweir          </tr>
212cdf0e10cSrcweir          <tr>
213cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_HOME</b></td>
214cdf0e10cSrcweir          <td class="cell80">Path to the SDK root directory, e.g.
215cdf0e10cSrcweir          &quot;/usr/local/StarOffice8_SDK&quot;</td>
216cdf0e10cSrcweir          </tr>
217cdf0e10cSrcweir          <tr>
218cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
219cdf0e10cSrcweir          <td class="cell80">Path to a JDK root directory. The JDK is
220cdf0e10cSrcweir          <b>optional</b> and only necessary if you like to run the Java examples
221cdf0e10cSrcweir          or if you like to use the SDK environment to develop your own Java
222cdf0e10cSrcweir          solution.</td>
223cdf0e10cSrcweir          </tr>
224cdf0e10cSrcweir          <tr>
225cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_CPP_HOME</b></td>
226cdf0e10cSrcweir          <td class="cell80">Path to the C++ compiler (on Windows, the directory
227cdf0e10cSrcweir          where the &quot;<i>vcvar32.bat</i>&quot; file can be found). The C++
228cdf0e10cSrcweir          compiler is <b>optional</b> and only necessary for building the C++
229cdf0e10cSrcweir          examples.</td>
230cdf0e10cSrcweir          </tr>
231cdf0e10cSrcweir          <tr>
232cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_CLI_HOME</b></td>
233cdf0e10cSrcweir          <td class="cell80">Path to the C# compiler and VB.NET compiler (on
234cdf0e10cSrcweir          Windows, this directory can be found under the system directory (e.g.
235cdf0e10cSrcweir          c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are
236cdf0e10cSrcweir          <b>optional</b> and only necessary for building the CLI examples.<br>
237cdf0e10cSrcweir          <b>Note: Windows only!</b></td>
238cdf0e10cSrcweir          </tr>
239cdf0e10cSrcweir          <tr>
240cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td>
241cdf0e10cSrcweir          <td class="cell80">Path to GNU make.</td>
242cdf0e10cSrcweir          </tr>
243cdf0e10cSrcweir          <tr>
244cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_ZIP_HOME</b></td>
245cdf0e10cSrcweir          <td class="cell80">Path to the 'zip' tool.</td>
246cdf0e10cSrcweir          </tr>
247cdf0e10cSrcweir          <tr>
248985d02c7SAriel Constenla-Haile          <td class="cell20"><b>OO_SDK_CAT_HOME</b></td>
249985d02c7SAriel Constenla-Haile          <td class="cell80">Path to the 'cat' tool.</td>
250985d02c7SAriel Constenla-Haile          </tr>
251985d02c7SAriel Constenla-Haile          <tr>
252985d02c7SAriel Constenla-Haile          <td class="cell20"><b>OO_SDK_SED_HOME</b></td>
253985d02c7SAriel Constenla-Haile          <td class="cell80">Path to the 'sed' tool.</td>
254985d02c7SAriel Constenla-Haile          </tr>
255985d02c7SAriel Constenla-Haile          <tr>
256cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
257cdf0e10cSrcweir          <td class="cell80">Path to an existing directory where the example output
258cdf0e10cSrcweir          is generated. The output directory is <b>optional</b>, by default
259cdf0e10cSrcweir          the output is generated in the SDK directory itself. If an output
260cdf0e10cSrcweir          directory is specified, the output is generated in a SDK dependent
261cdf0e10cSrcweir          subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
262*ff3f4ebcSOliver-Rainer Wittmann          /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>
263cdf0e10cSrcweir          </tr>
264cdf0e10cSrcweir          <tr>
265cdf0e10cSrcweir          <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
266cdf0e10cSrcweir          <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by
267cdf0e10cSrcweir          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.
268cdf0e10cSrcweir          This variable is only relevant when OFFICE_HOME is set.</td>
269cdf0e10cSrcweir          </tr>
270cdf0e10cSrcweir          </table>
271cdf0e10cSrcweir          <p>You must run the <b>setsdkenv_XXX</b> script every time you want to
272cdf0e10cSrcweir          use the configured SDK environment. The settings are local for the current
273cdf0e10cSrcweir          shell on Windows or the new started shell on UNIX. On UNIX you
274cdf0e10cSrcweir          can now source one of the prepared environment
275cdf0e10cSrcweir          script files (&quot;setsdkenv_unix.sh&quot; or
276cdf0e10cSrcweir          &quot;setsdkenv_unix.csh&quot; dependending on the shell you use) to prepare
277cdf0e10cSrcweir          your current shell instead of starting a new shell.</p>
278cdf0e10cSrcweir          </td>
279cdf0e10cSrcweir          </tr>
280cdf0e10cSrcweir          <tr valign="middle">
281cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
282cdf0e10cSrcweir          </tr>
283cdf0e10cSrcweir          <tr>
284cdf0e10cSrcweir            <td><img class="nothing10" src="images/nada.gif"></td>
285cdf0e10cSrcweir            <td align="right">
286cdf0e10cSrcweir            <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
287cdf0e10cSrcweir            <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
288cdf0e10cSrcweir          </tr>
289cdf0e10cSrcweir          <tr>
290cdf0e10cSrcweir          <td colspan="2">
291cdf0e10cSrcweir          <p class="head2">Manual Setting</p>
292cdf0e10cSrcweir          <p>If you do not want to use the script to set your working
293cdf0e10cSrcweir          environment, you must set the appropriate environment variables
294cdf0e10cSrcweir          yourself. The script sets the following environment variables:</p>
295cdf0e10cSrcweir          <p class="head3">Common Environment Variables</p>
296cdf0e10cSrcweir          <table class="table4">
297cdf0e10cSrcweir          <tr valign="top">
298cdf0e10cSrcweir          <td class="cell20">OO_SDK_NAME</td>
299cdf0e10cSrcweir          <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
300cdf0e10cSrcweir          </tr>
301cdf0e10cSrcweir          <tr valign="top">
302cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_BIN_DIR</td>
303cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
304cdf0e10cSrcweir          installation where binary executables are located (e.g.,
305cdf0e10cSrcweir          <i>$OFFICE_HOME/program</i> for an office installation, or
306cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/bin</i> for a Unix URE installation).</td>
307cdf0e10cSrcweir          </tr>
308cdf0e10cSrcweir          <tr valign="top">
309cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_LIB_DIR</td>
310cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
311cdf0e10cSrcweir          installation where dynamic libraries are located (e.g.,
312cdf0e10cSrcweir          <i>$OFFICE_HOME/program</i> for an office installation, or
313cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/lib</i> for a Unix URE installation).</td>
314cdf0e10cSrcweir          </tr>
315cdf0e10cSrcweir          <tr valign="top">
316cdf0e10cSrcweir          <td class="cell20">OO_SDK_URE_JAVA_DIR</td>
317cdf0e10cSrcweir          <td class="cell80">The path within the chosen office or URE
318cdf0e10cSrcweir          installation where Java JARs are located (e.g.,
319cdf0e10cSrcweir          <i>$OFFICE_HOME/program/classes</i> for an office installation, or
320cdf0e10cSrcweir          <i>$OO_SDK_URE_HOME/share/java</i> for a Unix URE installation).</td>
321cdf0e10cSrcweir          </tr>
322cdf0e10cSrcweir          <tr valign="top">
323cdf0e10cSrcweir          <td class="cell20">CLASSPATH</td>
324cdf0e10cSrcweir          <td class="cell80">
325cdf0e10cSrcweir          =<i>$OO_SDK_URE_JAVA_DIR/juh.jar;
326cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/jurt.jar;
327cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/ridl.jar;
328cdf0e10cSrcweir              $OO_SDK_URE_JAVA_DIR/unoloader.jar;
329cdf0e10cSrcweir              [$OO_SDK_URE_JAVA_DIR/unoil.jar;]
330cdf0e10cSrcweir              $CLASSPATH</i><br>
331cdf0e10cSrcweir          <p>The classpath will be set or extended to the necessary jar files of
332cdf0e10cSrcweir          the specified office installation. (<i>unoil.jar</i> is only included
333cdf0e10cSrcweir          when OFFICE_HOME is set.)</p>
334cdf0e10cSrcweir          </td>
335cdf0e10cSrcweir          </tr>
336cdf0e10cSrcweir          <tr valign="top">
337cdf0e10cSrcweir          <td class="cell20">OFFICE_PROGRAM_PATH</td>
338cdf0e10cSrcweir          <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
339cdf0e10cSrcweir          <p>This variable is used to find, for example, the office type library and
340cdf0e10cSrcweir          the UNO package deployment tool. This variable is only relevant when
341cdf0e10cSrcweir          OFFICE_HOME is set.</p>
342cdf0e10cSrcweir          </td>
343cdf0e10cSrcweir          </tr>
344cdf0e10cSrcweir          <tr valign="top">
345cdf0e10cSrcweir          <td class="cell20">UNO_PATH</td>
346cdf0e10cSrcweir          <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
347cdf0e10cSrcweir          <p>This variable is used to ensure that the new C++ UNO bootstrap
348cdf0e10cSrcweir          mechanism uses the configured office installation of the SDK. Normally
349cdf0e10cSrcweir          the bootstrap mechanism finds the default office installation for the
350cdf0e10cSrcweir          user on the system. This variable is optional but is set from the scripts
351cdf0e10cSrcweir          to ensure a homogeneous environment. Especially useful during development
352cdf0e10cSrcweir          where you might have more than one office installation installed. This
353cdf0e10cSrcweir          variable is only relevant when OFFICE_HOME is set.</p>
354cdf0e10cSrcweir          </td>
355cdf0e10cSrcweir          </tr>
356cdf0e10cSrcweir          </table>
357cdf0e10cSrcweir          <p class="head3">Environment Variables for UNIX</p>
358cdf0e10cSrcweir          <p class="head4">Solaris</p>
359cdf0e10cSrcweir          <table class="table4">
360cdf0e10cSrcweir          <tr valign="top">
361cdf0e10cSrcweir          <td class="cell20">LD_LIBRARY_PATH</td>
362cdf0e10cSrcweir          <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
363cdf0e10cSrcweir          <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
364cdf0e10cSrcweir          library path, the platform dependent lib directory for several additional
365cdf0e10cSrcweir          libraries.</p>
366cdf0e10cSrcweir          </td>
367cdf0e10cSrcweir          </tr>
368cdf0e10cSrcweir          <tr valign="top">
369cdf0e10cSrcweir          <td class="cell20">PATH</td>
370cdf0e10cSrcweir          <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>
371cdf0e10cSrcweir          <p>The PATH variable will be extended by the paths for the SDK development
372cdf0e10cSrcweir          tools, the compiler, the JDK, GNU make, the zip tool and the
373cdf0e10cSrcweir          OO_SDK_URE_BIN_DIR, where the compiler or the JDK are
374cdf0e10cSrcweir          optional.</p>
375cdf0e10cSrcweir          </td>
376cdf0e10cSrcweir          </tr>
377cdf0e10cSrcweir          <tr>
378cdf0e10cSrcweir          <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
379cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
380cdf0e10cSrcweir          the URE in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
381cdf0e10cSrcweir          needed for linking.</td>
382cdf0e10cSrcweir          </tr>
383cdf0e10cSrcweir          </table>
384cdf0e10cSrcweir          <p class="head4">Linux</p>
385cdf0e10cSrcweir          <table class="table4">
386cdf0e10cSrcweir          <tr valign="top">
387cdf0e10cSrcweir          <td class="cell20">LD_LIBRARY_PATH</td>
388cdf0e10cSrcweir          <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
389cdf0e10cSrcweir          <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE
390cdf0e10cSrcweir          library path, the platform dependent lib directory for some additional
391cdf0e10cSrcweir          libraries.</p>
392cdf0e10cSrcweir          </td>
393cdf0e10cSrcweir          </tr>
394cdf0e10cSrcweir          <tr valign="top">
395cdf0e10cSrcweir          <td class="cell20">PATH</td>
396cdf0e10cSrcweir          <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>
397cdf0e10cSrcweir          <p>The PATH variable will be extended by the paths for the SDK development
398cdf0e10cSrcweir          tools, the compiler, the JDK, GNU make, the zip tool and the
399cdf0e10cSrcweir          OO_SDK_URE_BIN_DIR, where the compiler and the JDK are
400cdf0e10cSrcweir          optional.</p>
401cdf0e10cSrcweir          </td>
402cdf0e10cSrcweir          </tr>
403cdf0e10cSrcweir          <tr>
404cdf0e10cSrcweir          <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script
405cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
406cdf0e10cSrcweir          the URE in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
407cdf0e10cSrcweir          linking.</td>
408cdf0e10cSrcweir          </tr>
409cdf0e10cSrcweir          </table>
410cdf0e10cSrcweir          <p class="head3">Environment Variables for Windows</p>
411cdf0e10cSrcweir          <table class="table4">
412cdf0e10cSrcweir          <tr valign="top">
413cdf0e10cSrcweir          <td class="cell20">PATH</td>
414cdf0e10cSrcweir          <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>
415cdf0e10cSrcweir          <p>The PATH variable will be extended by the paths for the SDK development
416cdf0e10cSrcweir          tools, the compiler, the JDK, GNU make, the zip tool and the
417cdf0e10cSrcweir          OO_SDK_URE_BIN_DIR.</p>
418cdf0e10cSrcweir          </td>
419cdf0e10cSrcweir          </tr>
420cdf0e10cSrcweir          <tr valign="top">
421cdf0e10cSrcweir          <td class="cell20">LIB</td>
422cdf0e10cSrcweir          <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
423cdf0e10cSrcweir          <p>The LIB variable will be extended by the path to the import libraries
424cdf0e10cSrcweir          that are necessary for Windows.</p>
425cdf0e10cSrcweir          </td>
426cdf0e10cSrcweir          </tr>
427cdf0e10cSrcweir          <tr valign="top">
428cdf0e10cSrcweir          <td colspan="2" class="cell80">In addition to setting these environment
429cdf0e10cSrcweir          variables, the script calls the &quot;<i>vcvar32.bat</i>&quot; batch file
430cdf0e10cSrcweir          which is provided by the Microsoft Developer Studio to set the necessary
431cdf0e10cSrcweir          environment variables for the compiler.</td>
432cdf0e10cSrcweir          </tr>
433cdf0e10cSrcweir          </table>
434cdf0e10cSrcweir          </td>
435cdf0e10cSrcweir          </tr>
436cdf0e10cSrcweir          </table>
437cdf0e10cSrcweir          </td>
438cdf0e10cSrcweir        </tr>
439cdf0e10cSrcweir      </table>
440cdf0e10cSrcweir    </td>
441cdf0e10cSrcweir  </tr>
442cdf0e10cSrcweir  <tr>
443cdf0e10cSrcweir    <td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
444cdf0e10cSrcweir  </tr>
445cdf0e10cSrcweir  <tr>
446cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
447cdf0e10cSrcweir  </tr>
448cdf0e10cSrcweir  <tr>
449cdf0e10cSrcweir    <td colspan="3">
450cdf0e10cSrcweir      <div class="centertext">
451ef1ef8e6SJürgen Schmidt    <p><img class="apachelogo" src="images/odk-footer-logo.gif" title="Apache Feather" alt="Apache Feather" />
452507825ddSAriel Constenla-Haile            Copyright &copy; 2011 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.<p>
453cdf0e10cSrcweir      </div>
454cdf0e10cSrcweir    </td>
455cdf0e10cSrcweir  </tr>
456cdf0e10cSrcweir</table>
457cdf0e10cSrcweir<map name="Map">
458ef1ef8e6SJürgen Schmidt  <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
459cdf0e10cSrcweir</map>
460cdf0e10cSrcweir</body>
461cdf0e10cSrcweir</html>
462