odk/docs/install.html

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