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