odk/docs/install.html

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