install.html (8d1a3dfa) install.html (508b4038)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
4#
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
9# to you under the Apache License, Version 2.0 (the
10# "License"); you may not use this file except in compliance
11# with the License. You may obtain a copy of the License at
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
9# to you under the Apache License, Version 2.0 (the
10# "License"); you may not use this file except in compliance
11# with the License. You may obtain a copy of the License at
12#
12#
13# http://www.apache.org/licenses/LICENSE-2.0
13# http://www.apache.org/licenses/LICENSE-2.0
14#
14#
15# Unless required by applicable law or agreed to in writing,
16# software distributed under the License is distributed on an
17# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18# KIND, either express or implied. See the License for the
19# specific language governing permissions and limitations
20# under the License.
15# Unless required by applicable law or agreed to in writing,
16# software distributed under the License is distributed on an
17# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18# KIND, either express or implied. See the License for the
19# specific language governing permissions and limitations
20# under the License.
21#
21#
22#**************************************************************
23 -->
24<html>
25<head>
26 <title>Apache OpenOffice %PRODUCT_RELEASE% SDK - Installation Guide</title>
27 <link rel="stylesheet" type="text/css" href="sdk_styles.css">
28 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
29 <meta name="author" content="J&uuml;rgen Schmidt">
30 <meta name="created" content="2004-12-14">
31</head>
32<body class="sdkbody"><a name="install"></a>
33<table class="table1" cellpadding=0>
22#**************************************************************
23 -->
24<html>
25<head>
26 <title>Apache OpenOffice %PRODUCT_RELEASE% SDK - Installation Guide</title>
27 <link rel="stylesheet" type="text/css" href="sdk_styles.css">
28 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
29 <meta name="author" content="J&uuml;rgen Schmidt">
30 <meta name="created" content="2004-12-14">
31</head>
32<body class="sdkbody"><a name="install"></a>
33<table class="table1" cellpadding=0>
34 <tr style="background-image:url(images/sdk_head-2.png)">
34 <tr style="background-image:url(images/sdk_head-2.png)">
35 <td colspan="3" align="left"><img src="images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
36 </tr>
35 <td colspan="3" align="left"><img src="images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
36 </tr>
37 <tr>
38 <td colspan="3"><img class="nothing10" src="images/nada.gif"></td>
37 <tr>
38 <td colspan="3"><img class="nothing10" src="images/nada.gif"></td>
39 </tr>
39 </tr>
40 <tr>
40 <tr>
41 <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
41 <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
42 <td>
42 <td>
43 <table class="table2">
43 <table class="table2">
44 <tr>
44 <tr>
45 <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
46 </tr>
45 <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
46 </tr>
47 <tr>
48 <td>
47 <tr>
48 <td>
49 <table class="table3">
49 <table class="table3">
50 <tr>
50 <tr>
51 <td colspan="2" class="head1">Installation Guide</td>
52 <td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
51 <td colspan="2" class="head1">Installation Guide</td>
52 <td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
53 </tr>
53 </tr>
54 </table>
55 </td>
56 </tr>
57 <tr>
54 </table>
55 </td>
56 </tr>
57 <tr>
58 <td>
58 <td>
59 <table class="table3">
59 <table class="table3">
60 <tr>
60 <tr>
61 <td colspan="2">
61 <td colspan="2">
62 <p>The Apache OpenOffice %PRODUCT_RELEASE% SDK comes with a set of development tools, base
63 libraries, header files and helper class files that can be used to
64 develop Java/C++ components, to embed the Apache OpenOffice %PRODUCT_RELEASE% application in
65 your own programs, or to use the API (scripting or remote control the
66 office). For a complete working environment, we have some additional
62 <p>The Apache OpenOffice %PRODUCT_RELEASE% SDK comes with a set of development tools, base
63 libraries, header files and helper class files that can be used to
64 develop Java/C++ components, to embed the Apache OpenOffice %PRODUCT_RELEASE% application in
65 your own programs, or to use the API (scripting or remote control the
66 office). For a complete working environment, we have some additional
67 requirements:</p>
68 </td>
67 requirements:</p>
68 </td>
69 </tr>
70 <tr valign="top">
69 </tr>
70 <tr valign="top">
71 <td><b>Apache OpenOffice %PRODUCT_RELEASE% installation</b></td>
71 <td><b>Apache OpenOffice %PRODUCT_RELEASE% installation</b></td>
72 <td class="content80">The SDK works on top of an existing office
72 <td class="content80">The SDK works on top of an existing office
73 installation and uses the same libraries as the office installation.</td>
73 installation and uses the same libraries as the office installation.</td>
74 </tr>
75 <tr valign="middle">
74 </tr>
75 <tr valign="middle">
76 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
77 </tr>
76 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
77 </tr>
78 <tr valign="top">
78 <tr valign="top">
79 <td><b>JDK (1.5 or higher)</b></td>
80 <td class="content80">
79 <td><b>JDK (1.5 or higher)</b></td>
80 <td class="content80">
81 <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>
81 <p>A JDK is necessary for developing Java components or applications. An appropriate Java SDK can be found on <a target="_blank" href="https://java.sun.com/products" title="link to the Java SDK download page (online)">https://java.sun.com/products</a>.</p>
82 <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p>
83 <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td>
84 </tr>
82 <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p>
83 <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td>
84 </tr>
85 <tr valign="middle">
85 <tr valign="middle">
86 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
87 </tr>
86 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
87 </tr>
88 <tr valign="top">
88 <tr valign="top">
89 <td><b>C++ compiler</b></td>
89 <td><b>C++ compiler</b></td>
90 <td class="content80">A C++ compiler is necessary for developing C++
91 components or applications. UNO depends on a compiler dependent language
92 binding, so that we use the appropriate compiler where a language binding
90 <td class="content80">A C++ compiler is necessary for developing C++
91 components or applications. UNO depends on a compiler dependent language
92 binding, so that we use the appropriate compiler where a language binding
93 exists:
94 <table class="table4">
95 <tr>
96 <td class="cell15">Solaris</td>
97 <td class="cell85">Sun Studio 8 (20070730)</td>
98 </tr>
99 <tr>
100 <td class="cell15">Linux</td>
101 <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td>
102 </tr>
103 <tr>
104 <td class="cell15">Windows</td>
105 <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td>
106 </tr>
107 </table>
108 <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>
109 </tr>
93 exists:
94 <table class="table4">
95 <tr>
96 <td class="cell15">Solaris</td>
97 <td class="cell85">Sun Studio 8 (20070730)</td>
98 </tr>
99 <tr>
100 <td class="cell15">Linux</td>
101 <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td>
102 </tr>
103 <tr>
104 <td class="cell15">Windows</td>
105 <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td>
106 </tr>
107 </table>
108 <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>
109 </tr>
110 <tr valign="middle">
110 <tr valign="middle">
111 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
112 </tr>
111 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
112 </tr>
113 <tr valign="top">
113 <tr valign="top">
114 <td><b>Microsoft .NET Framework SDK version 1.0 or higher</b></td>
114 <td><b>Microsoft .NET Framework SDK version 1.0 or higher</b></td>
115 <td class="content80">The SDK is required for building CLI applications.
115 <td class="content80">The SDK is required for building CLI applications.
116 That is, programs written in languages, such as C# or VB.NET.<br>
117 <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td>
118 </tr>
116 That is, programs written in languages, such as C# or VB.NET.<br>
117 <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td>
118 </tr>
119 <tr valign="middle">
119 <tr valign="middle">
120 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
121 </tr>
120 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
121 </tr>
122 <tr valign="top">
122 <tr valign="top">
123 <td><b>GNU make (3.79.1 or higher)</b></td>
124 <td class="content80">
125 <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>
126 <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
127 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>
128 </tr>
123 <td><b>GNU make (3.79.1 or higher)</b></td>
124 <td class="content80">
125 <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>
126 <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
127 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>
128 </tr>
129 <tr valign="middle">
129 <tr valign="middle">
130 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
131 </tr>
130 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
131 </tr>
132 <tr valign="top">
132 <tr valign="top">
133 <td><b>zip tool (2.3 or higher)</b></td>
133 <td><b>zip tool (2.3 or higher)</b></td>
134 <td class="content80">The zip tool is used to create UNO packages. zip is
134 <td class="content80">The zip tool is used to create UNO packages. zip is
135 a new requirement to make the SDK independent of a Java SDK.<br>
135 a new requirement to make the SDK independent of a Java SDK.<br>
136 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
136 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
137 the 4NT shell. You have to use the native w32 version.</td>
138 </tr>
139 <tr valign="middle">
140 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
141 </tr>
142 <tr valign="top">
143 <td><b>cat and sed tools</b></td>
144 <td class="content80">The cat and set tools are used to create some extensions.
145 <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
146 <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>
147 </td>
148 </tr>
137 the 4NT shell. You have to use the native w32 version.</td>
138 </tr>
139 <tr valign="middle">
140 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
141 </tr>
142 <tr valign="top">
143 <td><b>cat and sed tools</b></td>
144 <td class="content80">The cat and set tools are used to create some extensions.
145 <p><b>Note for Windows users</b>: If you do not have these already, you can download them from
146 <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>
147 </td>
148 </tr>
149 <tr valign="middle">
149 <tr valign="middle">
150 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
151 </tr>
152 <td><b>Boost (<b>Unix only</b> and optional)</b></td>
153 <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.
154 <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>
155 </td>
150 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
151 </tr>
152 <td><b>Boost (<b>Unix only</b> and optional)</b></td>
153 <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.
154 <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>
155 </td>
156 <tr valign="middle">
156 <tr valign="middle">
157 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
158 </tr>
157 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
158 </tr>
159 <tr>
159 <tr>
160 <td><img class="nothing10" src="images/nada.gif"></td>
161 <td align="right">
162 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
163 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
164 </tr>
160 <td><img class="nothing10" src="images/nada.gif"></td>
161 <td align="right">
162 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
163 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
164 </tr>
165 <tr valign="middle">
165 <tr valign="middle">
166 <td colspan="2">
167 <p>The SDK provides an implicit configuration mechanism, which
166 <td colspan="2">
167 <p>The SDK provides an implicit configuration mechanism, which
168 configures the SDK build environment to your personal needs the first
168 configures the SDK build environment to your personal needs the first
169 time you use the SDK environment. This configuration step creates a
170 new setsdkenv_XXX script in the user's home directory:</p>
171 <ul>
172 <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b>&nbsp;&nbsp;-> for Unix
169 time you use the SDK environment. This configuration step creates a
170 new setsdkenv_XXX script in the user's home directory:</p>
171 <ul>
172 <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b>&nbsp;&nbsp;-> for Unix
173 <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
173 <li><b>C:\Documents and Settings\&lt;username&gt;\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat</b>&nbsp;&nbsp;-> for Windows 2000/XP or later
174 </ul>
174 </ul>
175 <p>The automatically started configure script (Unix and Windows2000/XP)
176 requests relevant information and directories (SDK, the Office, GNU make,
177 Java, C++), in order to prepare a working SDK environment. After completing the
178 configure script once, the newly created script is always used to set the
179 necessary environment variables for using the SDK and the required
175 <p>The automatically started configure script (Unix and Windows 2000/XP)
176 requests relevant information and directories (SDK, the Office, GNU make,
177 Java, C++), in order to prepare a working SDK environment. After completing the
178 configure script once, the newly created script is always used to set the
179 necessary environment variables for using the SDK and the required
180 tools.</P>
180 tools.</P>
181 <p>On UNIX operating systems, the configure script uses Perl. LINUX systems should have
182 installed a working Perl version, and on Solaris you can find a working
183 Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if
184 necessary. On Windows, the configure script uses Windows Script and
185 a JScipt. If you have problems with Windows Script, you can download a
186 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>.
181 <p>On UNIX operating systems, the configure script uses Perl. Linux systems should have
182 installed a working Perl version, and on Solaris you can find a working
183 Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if
184 necessary. On Windows, the configure script uses Windows Script and
185 a JScipt. If you have problems with Windows Script, you can download a
186 newer version of <a href="https://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>.
187 </p>
187 </p>
188 <p>On other versions of Windows, use the batch
189 file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
188 <p>On other versions of Windows, use the batch
189 file template <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.template</b>,
190 rename it to *.bat, and adapt it to your local environment.</p>
190 rename it to *.bat, and adapt it to your local environment.</p>
191 <p>If you use the template batch file, edit and set
191 <p>If you use the template batch file, edit and set
192 the following variables:</p>
193 <table class="table4">
194 <tr valign="top">
195 <td class="cell20"><b>OFFICE_HOME</b></td>
192 the following variables:</p>
193 <table class="table4">
194 <tr valign="top">
195 <td class="cell20"><b>OFFICE_HOME</b></td>
196 <td class="cell80">Path to an existing Apache OpenOffice
197 installation, e.g. &quot;/opt/openoffice4&quot;. Be sure
196 <td class="cell80">Path to an existing Apache OpenOffice
197 installation, e.g. &quot;/opt/openoffice4&quot;. Be sure
198 that it is not a user installation only.</td>
199 </tr>
200 <tr><a name="oosdkname"></a>
201 <td class="cell20"><b>OO_SDK_NAME</b></td>
198 that it is not a user installation only.</td>
199 </tr>
200 <tr><a name="oosdkname"></a>
201 <td class="cell20"><b>OO_SDK_NAME</b></td>
202 <td class="cell80">The configuration uses the
203 directory name of the SDK, but you can use another name as well.
204 It is important that the name does not contain spaces, because of a limitation
205 of gnu make which cannot handle spaces correctly. This name is, for
206 example, used to create an output directory in the users home directory
202 <td class="cell80">The configuration uses the
203 directory name of the SDK, but you can use another name as well.
204 It is important that the name does not contain spaces, because of a limitation
205 of gnu make which cannot handle spaces correctly. This name is, for
206 example, used to create an output directory in the users home directory
207 for any generated output when you use the SDK build environment.</td>
208 </tr>
209 <tr>
210 <td class="cell20"><b>OO_SDK_HOME</b></td>
207 for any generated output when you use the SDK build environment.</td>
208 </tr>
209 <tr>
210 <td class="cell20"><b>OO_SDK_HOME</b></td>
211 <td class="cell80">Path to the SDK root directory, e.g.
212 &quot;/usr/local/StarOffice8_SDK&quot;</td>
211 <td class="cell80">Path to the SDK root directory, e.g.
212 &quot;/opt/openoffice4/sdk/&quot;</td>
213 </tr>
214 <tr>
215 <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
213 </tr>
214 <tr>
215 <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td>
216 <td class="cell80">Path to a JDK root directory. The JDK is
217 <b>optional</b> and only necessary if you like to run the Java examples
218 or if you like to use the SDK environment to develop your own Java
216 <td class="cell80">Path to a JDK root directory. The JDK is
217 <b>optional</b> and only necessary if you like to run the Java examples
218 or if you like to use the SDK environment to develop your own Java
219 solution.</td>
220 </tr>
221 <tr>
222 <td class="cell20"><b>OO_SDK_CPP_HOME</b></td>
219 solution.</td>
220 </tr>
221 <tr>
222 <td class="cell20"><b>OO_SDK_CPP_HOME</b></td>
223 <td class="cell80">Path to the C++ compiler (on Windows, the directory
224 where the &quot;<i>vcvar32.bat</i>&quot; file can be found). The C++
225 compiler is <b>optional</b> and only necessary for building the C++
223 <td class="cell80">Path to the C++ compiler (on Windows, the directory
224 where the &quot;<i>vcvar32.bat</i>&quot; file can be found). The C++
225 compiler is <b>optional</b> and only necessary for building the C++
226 examples.</td>
227 </tr>
228 <tr>
229 <td class="cell20"><b>OO_SDK_CLI_HOME</b></td>
226 examples.</td>
227 </tr>
228 <tr>
229 <td class="cell20"><b>OO_SDK_CLI_HOME</b></td>
230 <td class="cell80">Path to the C# compiler and VB.NET compiler (on
231 Windows, this directory can be found under the system directory (e.g.
232 c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are
230 <td class="cell80">Path to the C# compiler and VB.NET compiler (on
231 Windows, this directory can be found under the system directory (e.g.
232 c:\Windows\Microsoft.NET\Framework\v1.0.3705). The compilers are
233 <b>optional</b> and only necessary for building the CLI examples.<br>
234 <b>Note: Windows only!</b></td>
235 </tr>
236 <tr>
237 <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td>
238 <td class="cell80">Path to GNU make.</td>
239 </tr>
240 <tr>

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

250 <td class="cell80">Path to the 'sed' tool.</td>
251 </tr>
252 <tr>
253 <td class="cell20"><b>OO_SDK_BOOST_HOME</b></td>
254 <td class="cell80">Path to a boost installation, this is optional for C++ and Unix only.</td>
255 </tr>
256 <tr>
257 <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
233 <b>optional</b> and only necessary for building the CLI examples.<br>
234 <b>Note: Windows only!</b></td>
235 </tr>
236 <tr>
237 <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td>
238 <td class="cell80">Path to GNU make.</td>
239 </tr>
240 <tr>

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

250 <td class="cell80">Path to the 'sed' tool.</td>
251 </tr>
252 <tr>
253 <td class="cell20"><b>OO_SDK_BOOST_HOME</b></td>
254 <td class="cell80">Path to a boost installation, this is optional for C++ and Unix only.</td>
255 </tr>
256 <tr>
257 <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td>
258 <td class="cell80">Path to an existing directory where the example output
259 is generated. The output directory is <b>optional</b>, by default
260 the output is generated in the SDK directory itself. If an output
261 directory is specified, the output is generated in a SDK dependent
258 <td class="cell80">Path to an existing directory where the example output
259 is generated. The output directory is <b>optional</b>, by default
260 the output is generated in the SDK directory itself. If an output
261 directory is specified, the output is generated in a SDK dependent
262 subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
263 /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>
264 </tr>
265 <tr>
266 <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
262 subdirectory in this directory (e.g. &lt;OO_SDK_OUTPUT_DIR&gt;
263 /Apache OpenOffice %PRODUCT_RELEASE%/LINUXExample.out)</td>
264 </tr>
265 <tr>
266 <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
267 <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by
267 <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by
268 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.
269 This variable is only relevant when OFFICE_HOME is set.</td>
270 </tr>
271 </table>
268 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.
269 This variable is only relevant when OFFICE_HOME is set.</td>
270 </tr>
271 </table>
272 <p>You must run the <b>setsdkenv_XXX</b> script every time you want to
272 <p>You must run the <b>setsdkenv_XXX</b> script every time you want to
273 use the configured SDK environment. The settings are local for the current
273 use the configured SDK environment. The settings are local for the current
274 shell on Windows or the new started shell on UNIX. On UNIX you
275 can now source one of the prepared environment
276 script files (&quot;setsdkenv_unix.sh&quot; or
277 &quot;setsdkenv_unix.csh&quot; dependending on the shell you use) to prepare
274 shell on Windows or the new started shell on UNIX. On UNIX you
275 can now source one of the prepared environment
276 script files (&quot;setsdkenv_unix.sh&quot; or
277 &quot;setsdkenv_unix.csh&quot; depending on the shell you use) to prepare
278 your current shell instead of starting a new shell.</p>
279 </td>
280 </tr>
278 your current shell instead of starting a new shell.</p>
279 </td>
280 </tr>
281 <tr valign="middle">
281 <tr valign="middle">
282 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
283 </tr>
282 <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td>
283 </tr>
284 <tr>
284 <tr>
285 <td><img class="nothing10" src="images/nada.gif"></td>
286 <td align="right">
287 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
288 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
289 </tr>
290 <tr>
291 <td colspan="2">
292 <p class="head2">Manual Setting</p>
285 <td><img class="nothing10" src="images/nada.gif"></td>
286 <td align="right">
287 <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a>
288 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
289 </tr>
290 <tr>
291 <td colspan="2">
292 <p class="head2">Manual Setting</p>
293 <p>If you do not want to use the script to set your working
294 environment, you must set the appropriate environment variables
293 <p>If you do not want to use the script to set your working
294 environment, you must set the appropriate environment variables
295 yourself. The script sets the following environment variables:</p>
296 <p class="head3">Common Environment Variables</p>
297 <table class="table4">
298 <tr valign="top">
299 <td class="cell20">OO_SDK_NAME</td>
300 <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
301 </tr>
302 <tr valign="top">
303 <td class="cell20">OO_SDK_OFFICE_BIN_DIR</td>
304 <td class="cell80">The path to the program directory in the office installation (e.g. <i>$OFFICE_HOME/program</i>).</td>
305 </tr>
306 <tr valign="top">
307 <td class="cell20">OO_SDK_OFFICE_LIB_DIR</td>
295 yourself. The script sets the following environment variables:</p>
296 <p class="head3">Common Environment Variables</p>
297 <table class="table4">
298 <tr valign="top">
299 <td class="cell20">OO_SDK_NAME</td>
300 <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td>
301 </tr>
302 <tr valign="top">
303 <td class="cell20">OO_SDK_OFFICE_BIN_DIR</td>
304 <td class="cell80">The path to the program directory in the office installation (e.g. <i>$OFFICE_HOME/program</i>).</td>
305 </tr>
306 <tr valign="top">
307 <td class="cell20">OO_SDK_OFFICE_LIB_DIR</td>
308 <td class="cell80">The path to the office program directory in the office installtion (e.g. <i>$OFFICE_HOME/program</i>).</td>
308 <td class="cell80">The path to the office program directory in the office installation (e.g. <i>$OFFICE_HOME/program</i>).</td>
309 </tr>
310 <tr valign="top">
311 <td class="cell20">OO_SDK_OFFICE_JAVA_DIR</td>
309 </tr>
310 <tr valign="top">
311 <td class="cell20">OO_SDK_OFFICE_JAVA_DIR</td>
312 <td class="cell80">The path to the classes directory in the office program directory where Java JARs are located (e.g.
312 <td class="cell80">The path to the classes directory in the office program directory where Java JARs are located (e.g.
313 <i>$OFFICE_HOME/program/classes</i>).</td>
314 </tr>
315 <tr valign="top">
316 <td class="cell20">CLASSPATH</td>
317 <td class="cell80">
318 =<i>$OO_SDK_OFFICE_JAVA_DIR/juh.jar;
319 $OO_SDK_OFFICE_JAVA_DIR/jurt.jar;
320 $OO_SDK_OFFICE_JAVA_DIR/ridl.jar;
321 $OO_SDK_OFFICE_JAVA_DIR/unoloader.jar;
322 [$OO_SDK_OFFICE_JAVA_DIR/unoil.jar;]
323 $CLASSPATH</i><br>
313 <i>$OFFICE_HOME/program/classes</i>).</td>
314 </tr>
315 <tr valign="top">
316 <td class="cell20">CLASSPATH</td>
317 <td class="cell80">
318 =<i>$OO_SDK_OFFICE_JAVA_DIR/juh.jar;
319 $OO_SDK_OFFICE_JAVA_DIR/jurt.jar;
320 $OO_SDK_OFFICE_JAVA_DIR/ridl.jar;
321 $OO_SDK_OFFICE_JAVA_DIR/unoloader.jar;
322 [$OO_SDK_OFFICE_JAVA_DIR/unoil.jar;]
323 $CLASSPATH</i><br>
324 <p>The classpath will be set or extended to the necessary jar files of
324 <p>The classpath will be set or extended to the necessary jar files of
325 the specified office installation.</p>
326 </td>
327 </tr>
328 <tr valign="top">
329 <td class="cell20">OFFICE_PROGRAM_PATH</td>
330 <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
325 the specified office installation.</p>
326 </td>
327 </tr>
328 <tr valign="top">
329 <td class="cell20">OFFICE_PROGRAM_PATH</td>
330 <td class="cell80">=<i>$OFFICE_HOME/program</i><br>
331 <p>This variable is used to find, for example, the office type library and
331 <p>This variable is used to find, for example, the office type library and
332 the UNO package deployment tool.</p>
333 </td>
334 </tr>
335 <tr valign="top">
336 <td class="cell20">UNO_PATH</td>
337 <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
332 the UNO package deployment tool.</p>
333 </td>
334 </tr>
335 <tr valign="top">
336 <td class="cell20">UNO_PATH</td>
337 <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br>
338 <p>This variable is used to ensure that the new C++ UNO bootstrap
339 mechanism uses the configured office installation of the SDK. Normally
338 <p>This variable is used to ensure that the new C++ UNO bootstrap
339 mechanism uses the configured office installation of the SDK. Normally
340 the bootstrap mechanism finds the default office installation for the
341 user on the system. This variable is optional but is set from the scripts
342 to ensure a homogeneous environment. Especially useful during development
343 where you might have more than one office installation installed.</p>
344 </td>
345 </tr>
346 </table>
347 <p class="head3">Environment Variables for UNIX</p>
348 <p class="head4">Solaris</p>
349 <table class="table4">
350 <tr valign="top">
351 <td class="cell20">LD_LIBRARY_PATH</td>
352 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
353 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
340 the bootstrap mechanism finds the default office installation for the
341 user on the system. This variable is optional but is set from the scripts
342 to ensure a homogeneous environment. Especially useful during development
343 where you might have more than one office installation installed.</p>
344 </td>
345 </tr>
346 </table>
347 <p class="head3">Environment Variables for UNIX</p>
348 <p class="head4">Solaris</p>
349 <table class="table4">
350 <tr valign="top">
351 <td class="cell20">LD_LIBRARY_PATH</td>
352 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br>
353 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
354 library path, the platform dependent lib directory for several additional
354 library path, the platform dependent lib directory for several additional
355 libraries.</p>
356 </td>
357 </tr>
358 <tr valign="top">
359 <td class="cell20">PATH</td>
360 <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>
361 <p>The PATH variable will be extended by the paths for the SDK development
355 libraries.</p>
356 </td>
357 </tr>
358 <tr valign="top">
359 <td class="cell20">PATH</td>
360 <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>
361 <p>The PATH variable will be extended by the paths for the SDK development
362 tools, the compiler, the JDK, GNU make, the zip tool and the
363 OO_SDK_OFFICE_BIN_DIR, where the compiler or the JDK are
362 tools, the compiler, the JDK, GNU make, the zip tool and the
363 OO_SDK_OFFICE_BIN_DIR, where the compiler or the JDK are
364 optional.</p>
365 </td>
366 </tr>
367 <tr>
368 <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
369 additionally creates symbolic links to the public dynamic libraries of
370 the office UNO runtime in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
371 needed for linking.</td>
372 </tr>
373 </table>
374 <p class="head4">Linux</p>
375 <table class="table4">
376 <tr valign="top">
377 <td class="cell20">LD_LIBRARY_PATH</td>
378 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
379 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
364 optional.</p>
365 </td>
366 </tr>
367 <tr>
368 <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
369 additionally creates symbolic links to the public dynamic libraries of
370 the office UNO runtime in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are
371 needed for linking.</td>
372 </tr>
373 </table>
374 <p class="head4">Linux</p>
375 <table class="table4">
376 <tr valign="top">
377 <td class="cell20">LD_LIBRARY_PATH</td>
378 <td class="cell80">=<i>$OO_SDK_OFFICE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br>
379 <p>The LD_LIBRARY_PATH will be set or will be extended by the office
380 library path, the platform dependent lib directory for some additional
380 library path, the platform dependent lib directory for some additional
381 libraries.</p>
382 </td>
383 </tr>
384 <tr valign="top">
385 <td class="cell20">PATH</td>
386 <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>
387 <p>The PATH variable will be extended by the paths for the SDK development
381 libraries.</p>
382 </td>
383 </tr>
384 <tr valign="top">
385 <td class="cell20">PATH</td>
386 <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>
387 <p>The PATH variable will be extended by the paths for the SDK development
388 tools, the compiler, the JDK, GNU make, the zip tool and the
389 OO_SDK_OFFICE_BIN_DIR, where the compiler and the JDK are
388 tools, the compiler, the JDK, GNU make, the zip tool and the
389 OO_SDK_OFFICE_BIN_DIR, where the compiler and the JDK are
390 optional.</p>
391 </td>
392 </tr>
393 <tr>
394 <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
395 additionally creates symbolic links to the public dynamic libraries of
396 the office UNO runtime in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
397 linking.</td>
398 </tr>
399 </table>
400 <p class="head3">Environment Variables for Windows</p>
401 <table class="table4">
402 <tr valign="top">
403 <td class="cell20">PATH</td>
390 optional.</p>
391 </td>
392 </tr>
393 <tr>
394 <td colspan="2" class="cell80">Based on OFFICE_HOME, the script
395 additionally creates symbolic links to the public dynamic libraries of
396 the office UNO runtime in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for
397 linking.</td>
398 </tr>
399 </table>
400 <p class="head3">Environment Variables for Windows</p>
401 <table class="table4">
402 <tr valign="top">
403 <td class="cell20">PATH</td>
404 <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>
404 <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>
405 <p>The PATH variable will be extended by the paths for the SDK development
405 <p>The PATH variable will be extended by the paths for the SDK development
406 tools, the compiler, the JDK, GNU make, the zip tool and the
406 tools, the compiler, the JDK, GNU make, the zip tool and the
407 OO_SDK_OFFICE_BIN_DIR.</p>
408 </td>
409 </tr>
410 <tr valign="top">
411 <td class="cell20">LIB</td>
412 <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
407 OO_SDK_OFFICE_BIN_DIR.</p>
408 </td>
409 </tr>
410 <tr valign="top">
411 <td class="cell20">LIB</td>
412 <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br>
413 <p>The LIB variable will be extended by the path to the import libraries
413 <p>The LIB variable will be extended by the path to the import libraries
414 that are necessary for Windows.</p>
415 </td>
416 </tr>
417 <tr valign="top">
414 that are necessary for Windows.</p>
415 </td>
416 </tr>
417 <tr valign="top">
418 <td colspan="2" class="cell80">In addition to setting these environment
419 variables, the script calls the &quot;<i>vcvar32.bat</i>&quot; batch file
420 which is provided by the Microsoft Developer Studio to set the necessary
418 <td colspan="2" class="cell80">In addition to setting these environment
419 variables, the script calls the &quot;<i>vcvar32.bat</i>&quot; batch file
420 which is provided by the Microsoft Developer Studio to set the necessary
421 environment variables for the compiler.</td>
422 </tr>
423 </table>
424 </td>
425 </tr>
426 </table>
421 environment variables for the compiler.</td>
422 </tr>
423 </table>
424 </td>
425 </tr>
426 </table>
427 </td>
427 </td>
428 </tr>
429 </table>
430 </td>
431 </tr>
428 </tr>
429 </table>
430 </td>
431 </tr>
432 <tr>
432 <tr>
433 <td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
434 </tr>
433 <td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
434 </tr>
435 <tr>
435 <tr>
436 <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
437 </tr>
436 <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
437 </tr>
438 <tr>
439 <td colspan="3">
438 <tr>
439 <td colspan="3">
440 <div class="centertext">
441 <p><img class="apachelogo" src="images/sdk-footer-logo.png" title="Apache Logo" alt="Apache Logo">
442 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>
443 </div>
444 </td>
445 </tr>
446</table>
447<map name="Map">
448 <area shape="rect" coords="25,100,385,25" href="https://www.openoffice.org">
449</map>
450</body>
451</html>
440 <div class="centertext">
441 <p><img class="apachelogo" src="images/sdk-footer-logo.png" title="Apache Logo" alt="Apache Logo">
442 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>
443 </div>
444 </td>
445 </tr>
446</table>
447<map name="Map">
448 <area shape="rect" coords="25,100,385,25" href="https://www.openoffice.org">
449</map>
450</body>
451</html>