xref: /aoo42x/main/odk/docs/install.html (revision 8d1a3dfa)
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">
2899eb6ac2SMatthias Seidel  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
29cdf0e10cSrcweir  <meta name="author" content="J&uuml;rgen Schmidt">
30cdf0e10cSrcweir  <meta name="created" content="2004-12-14">
31cdf0e10cSrcweir</head>
322f8a5df7SMatthias Seidel<body class="sdkbody"><a name="install"></a>
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">
44907636efSMatthias Seidel	<tr>
45907636efSMatthias Seidel	  <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
46cdf0e10cSrcweir        </tr>
47cdf0e10cSrcweir        <tr>
48907636efSMatthias Seidel	  <td>
49907636efSMatthias Seidel            <table class="table3">
50907636efSMatthias Seidel	      <tr>
51907636efSMatthias Seidel		<td colspan="2" class="head1">Installation Guide</td>
52907636efSMatthias Seidel		<td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
53907636efSMatthias Seidel	      </tr>
54907636efSMatthias Seidel	    </table>
55907636efSMatthias Seidel	  </td>
56cdf0e10cSrcweir        </tr>
57907636efSMatthias Seidel	<tr>
58cdf0e10cSrcweir          <td>
59907636efSMatthias Seidel	    <table class="table3">
60907636efSMatthias Seidel	      <tr>
61907636efSMatthias Seidel		<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
65907636efSMatthias Seidel		  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>
68907636efSMatthias Seidel		</td>
69907636efSMatthias Seidel	      </tr>
70907636efSMatthias Seidel	      <tr valign="top">
7164c3c3eeSMatthias Seidel		<td><b>Apache OpenOffice %PRODUCT_RELEASE% installation</b></td>
7264c3c3eeSMatthias Seidel		<td class="content80">The SDK works on top of an existing office
7364c3c3eeSMatthias Seidel		installation and uses the same libraries as the office installation.</td>
7464c3c3eeSMatthias Seidel	      </tr>
7564c3c3eeSMatthias Seidel	      <tr valign="middle">
7664c3c3eeSMatthias Seidel		<td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
7764c3c3eeSMatthias Seidel	      </tr>
7864c3c3eeSMatthias Seidel	      <tr valign="top">
7964c3c3eeSMatthias Seidel		<td><b>JDK (1.5 or higher)</b></td>
80cdf0e10cSrcweir          <td class="content80">
81cdf0e10cSrcweir		  <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>
82cdf0e10cSrcweir		  <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p>
83cdf0e10cSrcweir		  <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td>
84cdf0e10cSrcweir          </tr>
85cdf0e10cSrcweir		  <tr valign="middle">
86cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
87cdf0e10cSrcweir          </tr>
88cdf0e10cSrcweir		  <tr valign="top">
89d353e71eSTsutomu Uchino          <td><b>C++ compiler</b></td>
90cdf0e10cSrcweir          <td class="content80">A C++ compiler is necessary for developing C++
91cdf0e10cSrcweir		  components or applications. UNO depends on a compiler dependent language
92cdf0e10cSrcweir		  binding, so that we use the appropriate compiler where a language binding
93cdf0e10cSrcweir		  exists:
94cdf0e10cSrcweir		  <table class="table4">
95cdf0e10cSrcweir		  <tr>
96cdf0e10cSrcweir		  <td class="cell15">Solaris</td>
97907636efSMatthias Seidel		  <td class="cell85">Sun Studio 8 (20070730)</td>
98cdf0e10cSrcweir		  </tr>
99cdf0e10cSrcweir		  <tr>
100cdf0e10cSrcweir		  <td class="cell15">Linux</td>
101cdf0e10cSrcweir		  <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td>
102cdf0e10cSrcweir		  </tr>
103cdf0e10cSrcweir		  <tr>
104cdf0e10cSrcweir		  <td class="cell15">Windows</td>
105cdf0e10cSrcweir		  <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td>
106cdf0e10cSrcweir		  </tr>
107cdf0e10cSrcweir		  </table>
10899eb6ac2SMatthias Seidel		  <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="https://www.microsoft.com/en-us/download/details.aspx?id=29">Microsoft Visual C++ 2008 Redistributable Package (x86)</a> is also installed. You can download this package from Microsoft directly.</p></td>
109cdf0e10cSrcweir          </tr>
110cdf0e10cSrcweir		  <tr valign="middle">
111cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
112cdf0e10cSrcweir          </tr>
113cdf0e10cSrcweir		  <tr valign="top">
114d353e71eSTsutomu Uchino          <td><b>Microsoft .NET Framework SDK version 1.0 or higher</b></td>
115cdf0e10cSrcweir          <td class="content80">The SDK is required for building CLI applications.
116cdf0e10cSrcweir		  That is, programs written in languages, such as C# or VB.NET.<br>
117cdf0e10cSrcweir		  <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td>
118cdf0e10cSrcweir          </tr>
119cdf0e10cSrcweir		  <tr valign="middle">
120cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
121cdf0e10cSrcweir          </tr>
122cdf0e10cSrcweir		  <tr valign="top">
123d353e71eSTsutomu Uchino          <td><b>GNU make (3.79.1 or higher)</b></td>
124cdf0e10cSrcweir          <td class="content80">
125907636efSMatthias Seidel		  <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 downloaded via FTP from <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>
126cdf0e10cSrcweir		  <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
127cdf0e10cSrcweir		  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>
128cdf0e10cSrcweir          </tr>
129cdf0e10cSrcweir		  <tr valign="middle">
130cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
131cdf0e10cSrcweir          </tr>
132cdf0e10cSrcweir		  <tr valign="top">
133d353e71eSTsutomu Uchino          <td><b>zip tool (2.3 or higher)</b></td>
134cdf0e10cSrcweir          <td class="content80">The zip tool is used to create UNO packages. zip is
135cdf0e10cSrcweir		  a new requirement to make the SDK independent of a Java SDK.<br>
136cdf0e10cSrcweir		  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
137cdf0e10cSrcweir		  the 4NT shell. You have to use the native w32 version.</td>
138985d02c7SAriel Constenla-Haile          </tr>
139985d02c7SAriel Constenla-Haile          <tr valign="middle">
140985d02c7SAriel Constenla-Haile            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
141985d02c7SAriel Constenla-Haile          </tr>
142985d02c7SAriel Constenla-Haile          <tr valign="top">
143d353e71eSTsutomu Uchino          <td><b>cat and sed tools</b></td>
144985d02c7SAriel Constenla-Haile          <td class="content80">The cat and set tools are used to create some extensions.
145985d02c7SAriel Constenla-Haile          <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
146907636efSMatthias Seidel          <a target="_blank" href="https://sourceforge.net/projects/unxutils/files/latest/download" title="link to UnxUtils (online)">https://sourceforge.net/projects/unxutils/files/latest/download</a>.</p>
147985d02c7SAriel Constenla-Haile          </td>
148cdf0e10cSrcweir          </tr>
149cdf0e10cSrcweir		  <tr valign="middle">
150cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
151ed9d7cbeSJürgen Schmidt          </tr>
152d353e71eSTsutomu Uchino          <td><b>Boost (<b>Unix only</b> and optional)</b></td>
153ed9d7cbeSJürgen Schmidt          <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.
15499eb6ac2SMatthias Seidel          <p><b>Download:</b> <a target="_blank" href="https://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)">https://sourceforge.net/projects/boost/files/boost/1.48.0/boost_1_48_0.tar.bz2/download</a>.</p>
155ed9d7cbeSJürgen Schmidt          </td>
156ed9d7cbeSJürgen Schmidt		  <tr valign="middle">
157ed9d7cbeSJürgen Schmidt            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
158cdf0e10cSrcweir          </tr>
159cdf0e10cSrcweir		  <tr>
160cdf0e10cSrcweir		    <td><img class="nothing10" src="images/nada.gif"></td>
161cdf0e10cSrcweir			<td align="right">
162cdf0e10cSrcweir			<a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
163cdf0e10cSrcweir			<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
164cdf0e10cSrcweir		  </tr>
165cdf0e10cSrcweir		  <tr valign="middle">
166cdf0e10cSrcweir          <td colspan="2">
167cdf0e10cSrcweir		  <p>The SDK provides an implicit configuration mechanism, which
168cdf0e10cSrcweir		  configures the SDK build environment to your personal needs the first
169985d02c7SAriel Constenla-Haile		  time you use the SDK environment. This configuration step creates a
170907636efSMatthias Seidel		  new setsdkenv_XXX script in the user's home directory:</p>
171cdf0e10cSrcweir		  <ul>
172985d02c7SAriel Constenla-Haile		    <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b>&nbsp;&nbsp;-> for Unix
173985d02c7SAriel 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
174cdf0e10cSrcweir          </ul>
175cdf0e10cSrcweir		  <p>The automatically started configure script (Unix and Windows2000/XP)
176ef1ef8e6SJürgen Schmidt		  requests relevant information and directories (SDK, the Office, GNU make,
177cdf0e10cSrcweir		  Java, C++), in order to prepare a working SDK environment. After completing the
178cdf0e10cSrcweir		  configure script once, the newly created script is always used to set the
179cdf0e10cSrcweir		  necessary environment variables for using the SDK and the required
180cdf0e10cSrcweir		  tools.</P>
181cdf0e10cSrcweir		  <p>On UNIX operating systems, the configure script uses Perl. LINUX systems should have
182cdf0e10cSrcweir		  installed a working Perl version, and on Solaris you can find a working
183cdf0e10cSrcweir		  Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if
184cdf0e10cSrcweir		  necessary. On Windows, the configure script uses Windows Script and
185cdf0e10cSrcweir		  a JScipt. If you have problems with Windows Script, you can download a
186d353e71eSTsutomu Uchino		  newer version of <a href="http://www.microsoft.com/downloads/details.aspx?FamilyId=C717D943-7E4B-4622-86EB-95A22B832CAA&amp;displaylang=en" title="link to the download page for the Windows Script">Windows Script</a>.
187cdf0e10cSrcweir          </p>
188cdf0e10cSrcweir          <p>On other versions of Windows, use the batch
189cdf0e10cSrcweir		  file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
190cdf0e10cSrcweir		  rename it to *.bat, and adapt it to your local environment.</p>
191cdf0e10cSrcweir		  <p>If you use the template batch file, edit and set
192cdf0e10cSrcweir		  the following variables:</p>
193cdf0e10cSrcweir		  <table class="table4">
194cdf0e10cSrcweir		  <tr valign="top">
195cdf0e10cSrcweir		  <td class="cell20"><b>OFFICE_HOME</b></td>
196ef1ef8e6SJürgen Schmidt		  <td class="cell80">Path to an existing Apache OpenOffice
197ed9d7cbeSJürgen Schmidt		  installation, e.g. &quot;/opt/openoffice4&quot;. Be sure
198ed9d7cbeSJürgen Schmidt		  that it is not a user installation only.</td>
199cdf0e10cSrcweir		  </tr>
2002f8a5df7SMatthias Seidel          <tr><a name="oosdkname"></a>
201cdf0e10cSrcweir          <td class="cell20"><b>OO_SDK_NAME</b></td>
202cdf0e10cSrcweir          <td class="cell80">The configuration uses the
203cdf0e10cSrcweir		  directory name of the SDK, but you can use another name as well.
204cdf0e10cSrcweir		  It is important that the name does not contain spaces, because of a limitation
205cdf0e10cSrcweir		  of gnu make which cannot handle spaces correctly. This name is, for
206cdf0e10cSrcweir		  example, used to create an output directory in the users home directory
207cdf0e10cSrcweir		  for any generated output when you use the SDK build environment.</td>
208cdf0e10cSrcweir          </tr>
209cdf0e10cSrcweir		  <tr>
210cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_HOME</b></td>
211cdf0e10cSrcweir		  <td class="cell80">Path to the SDK root directory, e.g.
212cdf0e10cSrcweir		  &quot;/usr/local/StarOffice8_SDK&quot;</td>
213cdf0e10cSrcweir		  </tr>
214cdf0e10cSrcweir		  <tr>
215cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
216cdf0e10cSrcweir		  <td class="cell80">Path to a JDK root directory. The JDK is
217cdf0e10cSrcweir		  <b>optional</b> and only necessary if you like to run the Java examples
218cdf0e10cSrcweir		  or if you like to use the SDK environment to develop your own Java
219cdf0e10cSrcweir		  solution.</td>
220cdf0e10cSrcweir		  </tr>
221cdf0e10cSrcweir		  <tr>
222cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_CPP_HOME</b></td>
223cdf0e10cSrcweir		  <td class="cell80">Path to the C++ compiler (on Windows, the directory
224cdf0e10cSrcweir		  where the &quot;<i>vcvar32.bat</i>&quot; file can be found). The C++
225cdf0e10cSrcweir		  compiler is <b>optional</b> and only necessary for building the C++
226cdf0e10cSrcweir		  examples.</td>
227cdf0e10cSrcweir		  </tr>
228cdf0e10cSrcweir		  <tr>
229cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_CLI_HOME</b></td>
230cdf0e10cSrcweir		  <td class="cell80">Path to the C# compiler and VB.NET compiler (on
231cdf0e10cSrcweir		  Windows, this directory can be found under the system directory (e.g.
232cdf0e10cSrcweir		  c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are
233cdf0e10cSrcweir		  <b>optional</b> and only necessary for building the CLI examples.<br>
234cdf0e10cSrcweir		  <b>Note: Windows only!</b></td>
235cdf0e10cSrcweir		  </tr>
236cdf0e10cSrcweir		  <tr>
237cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td>
238cdf0e10cSrcweir		  <td class="cell80">Path to GNU make.</td>
239cdf0e10cSrcweir		  </tr>
240cdf0e10cSrcweir		  <tr>
241cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_ZIP_HOME</b></td>
242cdf0e10cSrcweir		  <td class="cell80">Path to the 'zip' tool.</td>
243cdf0e10cSrcweir		  </tr>
244985d02c7SAriel Constenla-Haile          <tr>
245985d02c7SAriel Constenla-Haile          <td class="cell20"><b>OO_SDK_CAT_HOME</b></td>
246985d02c7SAriel Constenla-Haile          <td class="cell80">Path to the 'cat' tool.</td>
247985d02c7SAriel Constenla-Haile          </tr>
248985d02c7SAriel Constenla-Haile          <tr>
249985d02c7SAriel Constenla-Haile          <td class="cell20"><b>OO_SDK_SED_HOME</b></td>
250985d02c7SAriel Constenla-Haile          <td class="cell80">Path to the 'sed' tool.</td>
251ed9d7cbeSJürgen Schmidt          </tr>
252ed9d7cbeSJürgen Schmidt          <tr>
253ed9d7cbeSJürgen Schmidt          <td class="cell20"><b>OO_SDK_BOOST_HOME</b></td>
254ed9d7cbeSJürgen Schmidt          <td class="cell80">Path to a boost installation, this is optional for C++ and Unix only.</td>
255985d02c7SAriel Constenla-Haile          </tr>
256cdf0e10cSrcweir		  <tr>
257cdf0e10cSrcweir		  <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
258cdf0e10cSrcweir		  <td class="cell80">Path to an existing directory where the example output
259cdf0e10cSrcweir		  is generated. The output directory is <b>optional</b>, by default
260cdf0e10cSrcweir		  the output is generated in the SDK directory itself. If an output
261cdf0e10cSrcweir		  directory is specified, the output is generated in a SDK dependent
262cdf0e10cSrcweir		  subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
263ff3f4ebcSOliver-Rainer Wittmann		  /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>
264cdf0e10cSrcweir		  </tr>
265cdf0e10cSrcweir		  <tr>
266cdf0e10cSrcweir		  <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
267cdf0e10cSrcweir		  <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by
26880295734SMatthias Seidel		  OFFICE_HOME. See also chapter <a href="https://wiki.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.
26999eb6ac2SMatthias Seidel		  This variable is only relevant when OFFICE_HOME is set.</td>
270cdf0e10cSrcweir		  </tr>
271cdf0e10cSrcweir		  </table>
272cdf0e10cSrcweir		  <p>You must run the <b>setsdkenv_XXX</b> script every time you want to
273cdf0e10cSrcweir		  use the configured SDK environment. The settings are local for the current
274cdf0e10cSrcweir		  shell on Windows or the new started shell on UNIX. On UNIX you
275cdf0e10cSrcweir		  can now source one of the prepared environment
276cdf0e10cSrcweir		  script files (&quot;setsdkenv_unix.sh&quot; or
277cdf0e10cSrcweir		  &quot;setsdkenv_unix.csh&quot; dependending on the shell you use) to prepare
278cdf0e10cSrcweir		  your current shell instead of starting a new shell.</p>
279cdf0e10cSrcweir		  </td>
280cdf0e10cSrcweir          </tr>
281cdf0e10cSrcweir		  <tr valign="middle">
282cdf0e10cSrcweir            <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
283cdf0e10cSrcweir          </tr>
284cdf0e10cSrcweir		  <tr>
285cdf0e10cSrcweir		    <td><img class="nothing10" src="images/nada.gif"></td>
286cdf0e10cSrcweir			<td align="right">
287cdf0e10cSrcweir			<a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
288cdf0e10cSrcweir			<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
289cdf0e10cSrcweir		  </tr>
290cdf0e10cSrcweir		  <tr>
291cdf0e10cSrcweir		  <td colspan="2">
292cdf0e10cSrcweir		  <p class="head2">Manual Setting</p>
293cdf0e10cSrcweir		  <p>If you do not want to use the script to set your working
294cdf0e10cSrcweir		  environment, you must set the appropriate environment variables
295cdf0e10cSrcweir		  yourself. The script sets the following environment variables:</p>
296cdf0e10cSrcweir		  <p class="head3">Common Environment Variables</p>
297cdf0e10cSrcweir		  <table class="table4">
298cdf0e10cSrcweir          <tr valign="top">
299cdf0e10cSrcweir          <td class="cell20">OO_SDK_NAME</td>
300cdf0e10cSrcweir          <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
301cdf0e10cSrcweir          </tr>
302cdf0e10cSrcweir          <tr valign="top">
303ed9d7cbeSJürgen Schmidt          <td class="cell20">OO_SDK_OFFICE_BIN_DIR</td>
304ed9d7cbeSJürgen Schmidt          <td class="cell80">The path to the program directory in the office installation (e.g. <i>$OFFICE_HOME/program</i>).</td>
305cdf0e10cSrcweir          </tr>
306cdf0e10cSrcweir          <tr valign="top">
307ed9d7cbeSJürgen Schmidt          <td class="cell20">OO_SDK_OFFICE_LIB_DIR</td>
308ed9d7cbeSJürgen Schmidt          <td class="cell80">The path to the office program directory in the office installtion (e.g. <i>$OFFICE_HOME/program</i>).</td>
309cdf0e10cSrcweir          </tr>
310cdf0e10cSrcweir          <tr valign="top">
311ed9d7cbeSJürgen Schmidt          <td class="cell20">OO_SDK_OFFICE_JAVA_DIR</td>
31264c3c3eeSMatthias Seidel          <td class="cell80">The path to the classes directory in the office program directory where Java JARs are located (e.g.
313ed9d7cbeSJürgen Schmidt          <i>$OFFICE_HOME/program/classes</i>).</td>
314cdf0e10cSrcweir          </tr>
315cdf0e10cSrcweir		  <tr valign="top">
316cdf0e10cSrcweir		  <td class="cell20">CLASSPATH</td>
317cdf0e10cSrcweir		  <td class="cell80">
318ed9d7cbeSJürgen Schmidt          =<i>$OO_SDK_OFFICE_JAVA_DIR/juh.jar;
319ed9d7cbeSJürgen Schmidt              $OO_SDK_OFFICE_JAVA_DIR/jurt.jar;
320ed9d7cbeSJürgen Schmidt              $OO_SDK_OFFICE_JAVA_DIR/ridl.jar;
321ed9d7cbeSJürgen Schmidt              $OO_SDK_OFFICE_JAVA_DIR/unoloader.jar;
322ed9d7cbeSJürgen Schmidt              [$OO_SDK_OFFICE_JAVA_DIR/unoil.jar;]
323cdf0e10cSrcweir              $CLASSPATH</i><br>
324cdf0e10cSrcweir          <p>The classpath will be set or extended to the necessary jar files of
325ed9d7cbeSJürgen Schmidt		  the specified office installation.</p>
326cdf0e10cSrcweir		  </td>
327cdf0e10cSrcweir		  </tr>
328cdf0e10cSrcweir		  <tr valign="top">
329cdf0e10cSrcweir		  <td class="cell20">OFFICE_PROGRAM_PATH</td>
330cdf0e10cSrcweir		  <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
331cdf0e10cSrcweir		  <p>This variable is used to find, for example, the office type library and
332ed9d7cbeSJürgen Schmidt		  the UNO package deployment tool.</p>
333cdf0e10cSrcweir		  </td>
334cdf0e10cSrcweir		  </tr>
335cdf0e10cSrcweir		  <tr valign="top">
336cdf0e10cSrcweir		  <td class="cell20">UNO_PATH</td>
337cdf0e10cSrcweir		  <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
338cdf0e10cSrcweir          <p>This variable is used to ensure that the new C++ UNO bootstrap
339cdf0e10cSrcweir		  mechanism uses the configured office installation of the SDK. Normally
340cdf0e10cSrcweir		  the bootstrap mechanism finds the default office installation for the
341cdf0e10cSrcweir		  user on the system. This variable is optional but is set from the scripts
342cdf0e10cSrcweir		  to ensure a homogeneous environment. Especially useful during development
343ed9d7cbeSJürgen Schmidt		  where you might have more than one office installation installed.</p>
344cdf0e10cSrcweir		  </td>
345cdf0e10cSrcweir		  </tr>
346cdf0e10cSrcweir		  </table>
347cdf0e10cSrcweir		  <p class="head3">Environment Variables for UNIX</p>
348cdf0e10cSrcweir		  <p class="head4">Solaris</p>
349cdf0e10cSrcweir		  <table class="table4">
350cdf0e10cSrcweir		  <tr valign="top">
351cdf0e10cSrcweir		  <td class="cell20">LD_LIBRARY_PATH</td>
352ed9d7cbeSJürgen Schmidt		  <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
353ed9d7cbeSJürgen Schmidt		  <p>The LD_LIBRARY_PATH will be set or will be extended by the office
354cdf0e10cSrcweir		  library path, the platform dependent lib directory for several additional
355cdf0e10cSrcweir		  libraries.</p>
356cdf0e10cSrcweir		  </td>
357cdf0e10cSrcweir		  </tr>
358cdf0e10cSrcweir		  <tr valign="top">
359cdf0e10cSrcweir		  <td class="cell20">PATH</td>
360907636efSMatthias Seidel		  <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><br>
361cdf0e10cSrcweir          <p>The PATH variable will be extended by the paths for the SDK development
362cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
363ed9d7cbeSJürgen Schmidt		  OO_SDK_OFFICE_BIN_DIR, where the compiler or the JDK are
364cdf0e10cSrcweir		  optional.</p>
365cdf0e10cSrcweir		  </td>
366cdf0e10cSrcweir		  </tr>
367cdf0e10cSrcweir          <tr>
368907636efSMatthias Seidel          <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
369cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
370ed9d7cbeSJürgen Schmidt          the office UNO runtime in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
371cdf0e10cSrcweir          needed for linking.</td>
372cdf0e10cSrcweir          </tr>
373cdf0e10cSrcweir		  </table>
374cdf0e10cSrcweir		  <p class="head4">Linux</p>
375cdf0e10cSrcweir		  <table class="table4">
376cdf0e10cSrcweir		  <tr valign="top">
377cdf0e10cSrcweir		  <td class="cell20">LD_LIBRARY_PATH</td>
378ed9d7cbeSJürgen Schmidt		  <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
379ed9d7cbeSJürgen Schmidt		  <p>The LD_LIBRARY_PATH will be set or will be extended by the office
380cdf0e10cSrcweir		  library path, the platform dependent lib directory for some additional
381cdf0e10cSrcweir		  libraries.</p>
382cdf0e10cSrcweir		  </td>
383cdf0e10cSrcweir		  </tr>
384cdf0e10cSrcweir		  <tr valign="top">
385cdf0e10cSrcweir		  <td class="cell20">PATH</td>
386ed9d7cbeSJürgen Schmidt		  <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>
387cdf0e10cSrcweir		  <p>The PATH variable will be extended by the paths for the SDK development
388cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
389ed9d7cbeSJürgen Schmidt		  OO_SDK_OFFICE_BIN_DIR, where the compiler and the JDK are
390cdf0e10cSrcweir		  optional.</p>
391cdf0e10cSrcweir		  </td>
392cdf0e10cSrcweir		  </tr>
393cdf0e10cSrcweir          <tr>
394ed9d7cbeSJürgen Schmidt          <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
395cdf0e10cSrcweir          additionally creates symbolic links to the public dynamic libraries of
396ed9d7cbeSJürgen Schmidt          the office UNO runtime in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
397cdf0e10cSrcweir          linking.</td>
398cdf0e10cSrcweir          </tr>
399cdf0e10cSrcweir		  </table>
400cdf0e10cSrcweir		  <p class="head3">Environment Variables for Windows</p>
401cdf0e10cSrcweir		  <table class="table4">
402cdf0e10cSrcweir		  <tr valign="top">
403cdf0e10cSrcweir		  <td class="cell20">PATH</td>
404ed9d7cbeSJürgen Schmidt		  <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>
405cdf0e10cSrcweir		  <p>The PATH variable will be extended by the paths for the SDK development
406cdf0e10cSrcweir		  tools, the compiler, the JDK, GNU make, the zip tool and the
407ed9d7cbeSJürgen Schmidt		  OO_SDK_OFFICE_BIN_DIR.</p>
408cdf0e10cSrcweir		  </td>
409cdf0e10cSrcweir		  </tr>
410cdf0e10cSrcweir		  <tr valign="top">
411cdf0e10cSrcweir		  <td class="cell20">LIB</td>
412cdf0e10cSrcweir		  <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
413cdf0e10cSrcweir		  <p>The LIB variable will be extended by the path to the import libraries
414cdf0e10cSrcweir		  that are necessary for Windows.</p>
415cdf0e10cSrcweir		  </td>
416cdf0e10cSrcweir		  </tr>
417cdf0e10cSrcweir		  <tr valign="top">
418cdf0e10cSrcweir		  <td colspan="2" class="cell80">In addition to setting these environment
419cdf0e10cSrcweir		  variables, the script calls the &quot;<i>vcvar32.bat</i>&quot; batch file
420cdf0e10cSrcweir		  which is provided by the Microsoft Developer Studio to set the necessary
421cdf0e10cSrcweir		  environment variables for the compiler.</td>
422cdf0e10cSrcweir		  </tr>
423cdf0e10cSrcweir		  </table>
424cdf0e10cSrcweir		  </td>
425cdf0e10cSrcweir		  </tr>
426cdf0e10cSrcweir		  </table>
427cdf0e10cSrcweir          </td>
428cdf0e10cSrcweir		</tr>
429cdf0e10cSrcweir	  </table>
430cdf0e10cSrcweir	</td>
431cdf0e10cSrcweir  </tr>
432cdf0e10cSrcweir  <tr>
433cdf0e10cSrcweir    <td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
434cdf0e10cSrcweir  </tr>
435cdf0e10cSrcweir  <tr>
436cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
437cdf0e10cSrcweir  </tr>
438cdf0e10cSrcweir  <tr>
439cdf0e10cSrcweir    <td colspan="3">
440cdf0e10cSrcweir      <div class="centertext">
44164c3c3eeSMatthias Seidel	<p><img class="apachelogo" src="images/sdk-footer-logo.png" title="Apache Logo" alt="Apache Logo">
442*8d1a3dfaSMatthias Seidel            Copyright &copy; 2011-2019 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>
443cdf0e10cSrcweir      </div>
444cdf0e10cSrcweir    </td>
445cdf0e10cSrcweir  </tr>
446cdf0e10cSrcweir</table>
447cdf0e10cSrcweir<map name="Map">
448a02e2aebSMatthias Seidel  <area shape="rect" coords="25,100,385,25" href="https://www.openoffice.org">
449cdf0e10cSrcweir</map>
450cdf0e10cSrcweir</body>
451cdf0e10cSrcweir</html>
452