Skip to content

start:

Building OpenOffice.org 2.x (680er series) under Linux

Beware! The build instructions for OpenOffice.org 1.1.x (and older) are different!

Last changes made: $Date: 2008/03/07 14:06:09 $

This document describes the requirements and actions that you need to build OpenOffice.org on Linux.

Commands you have to type on the keyboard follow this syntax throughout this document: 

config_office> ./configure

In this example, the script configure is executed in the directory config_office.

Since OpenOffice.org 2.1.x (SRC680_m175) it is possible to use bash instead of tcsh. This has to be enabled with the --with-use-shell configure switch. The following instructions are for the tcsh case but the savy *NIX user should be able to guess the needed changes. The environment file for bash adds an additional .sh suffix to the tcsh environment filename.

$SRC_ROOT will denote the directory in which the source code of OpenOffice.org is stored.


Table of Contents




Overview

This section is meant as a reminder or checklist for those who have some experience in building OpenOffice.org. Everybody else should jump to the Build Requirements section.

Even experienced builders are well advised to check the release notes at http://development.openoffice.org/releases/2.0.0rc2.html and the section Build Requirements in this document to inform yourself about changes since the previous releases.

Detailed step-by-step build descriptions are given from the next section on.

Overview of Performing a Full Build

To perform a full build, you need to follow these steps:

  1. Get the source code, either from the download webpage (http://download.openoffice.org/680/index.html) or alternatively via a check-out from the cvs tree against a release tag, e.g. OpenOffice_2_0_0.
  2. Run the configure script to check all requirements and to create the script LinuxIntelEnv.Set.
  3. Source the LinuxIntelEnv.Set script to set all environment variables.

    Please see the last screen from the configure script for more specific information on setting up for your platform.

  4. Create the build tools using bootstrap.
  5. Recompute tcsh's directory hash using rehash.
  6. Build typing dmake in $SRC_ROOT, or build --all in the instetoo_native module, or build followed by deliver in the individual modules.
For detailed build instructions, see the section Building a Full Build of the Office Suite in this document. The installation procedure is described at the end of this document.



Build Requirements

Before you start building, you must ensure that your system satisfies the recommended software and hardware requirements for the type of system you are working on. For Linux, these are as follows:

Software Requirements

  • glibc 2.1.x or higher
  • gcc: OpenOffice.org has been successfully build under Linux using the gcc versions greater 3.3.x. The recommended version is 3.4.1, also 4.1.x version are reported to work.
  • The X11 development libraries and header files should be installed. Should be in place with most Linux distributions.

    Note the there are currently some issues with X version 4.3.

  • PAM (should come with most Linux distributions). You must install the development package for your distribution.
  • JDK 1.3.1 or JDK 1.4.2 (note you need the SDK, not just the JRE).
    JDK 1.5.0 is supported starting from m158 (OOo 2.0.3), see issue 59368.
  • If you are building with JDK 1.3.1, you need to download crimson.jar from http://xml.apache.org/crimson/ and xalan.jar and xml-apis.jar from http://xml.apache.org/xalan-j/index.html and add these to the compilation classpath
  • Perl 5
  • csh   Note that you can start a build in bash however all the scripts in the build system are actually csh scripts.
  • zip and unzip
  • The gpc general polygon clipper library release 2.31, located at http://www.cs.man.ac.uk/aig/staff/alan/software/. Download and unpack the tarball. You should have the files gpc.c and gpc.h in $SRC_ROOT/external/gpc.
  • GTK - If you enable the crash reporter in configure then you need the gtk 2, jpeg and tiff development libraries.
  • Ant Is required to build some features. This is a Java Make utility.
  • gperf Is required to build some modules.
  • Mozilla libraries
    Some Mozilla libraries are needed. Choose one of the following three options.
    • Build the libraries
      Get the source from here, copy it into $SRC_ROOT/moz/download and configure will detect the source archive.
    • Use prebuild libraries
      Place LINUXGCCI{inc,lib,runtile}.zip into $SRC_ROOT/moz/zipped. You have to configure with --disable-build-mozilla to enable the use of the prebuild libraries. The files can be found here or can be reused if the packages were build following the instructions of the previous point. In the latter case they can be found in $SRC_ROOT/moz/unxlngi6.pro of a successfull build.
    • Don't use the libraries
      By using the --disable-mozilla switch for configure you waive the extra functionality.

Perl Module requirements

This is a list of the perl modules that have to be installed.

Module: Used for:
Archive::Zip packing image lists, evtl. for further zipping needs
XML::Parser expat based parser for the new XML based build lists

Perl - Additional CWS tooling requirements

For committers who want to use the CWS tooling

Module: Used for:
Crypt::SSLeay for SSL encrypted SOAP connections.
SOAP::Lite access the SOAP based CWS webservice.

Hardware Requirements

  • Intel Pentium II (P4 recommended)
  • 256 MB RAM (Much more recommended)
  • 4 Gb free disk space, add approximately 2 Gb to build with --with-lang=ALL option. Approximately 8 Gb with full crash report enabled, --enable-crashdump.


External Components

The code contains some further external components which are already provided. If you are interested in details about these, look at the External Components webpage at http://tools.openoffice.org/ext_comp.html.




Get the source code

You have two options to get the source code:

  • Download the source code tarball (http://download.openoffice.org/2.0.0/source.html), e.g. OOo_2.0.0_src.tar.gz in case of the 2.0 stable release.

    Unpack the tarballs as follows:

    > tar -xvzf OOo_2.0.0_src.tar.gz
> cd OOo_2.0.0rc3_src

    This will be $SRC_ROOT from now on.

  • Another possibility is to check out the code from the cvs tree. If you don't have a username and password, you can still do a checkout as anoncvs: 
    > cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs login
    Just press enter when prompted for the password. 
    > cd $SRC_ROOT
$SRC_ROOT> cvs /
    -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
    co -r OpenOffice_2_0_0 OpenOffice2
    The non-bold slash means that the command should be in one line. It is possible to update an already existing older copy to a newer release: 
    $SRC_ROOT> cvs /
    -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
    update -r OpenOffice_2_0_0 OpenOffice2
  • If you're only interested in building individual modules, you won't need the entire source code. You can check out individual modules from the cvs tree: 
    $SRC_ROOT> cvs /
    -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
    co -r OpenOffice_2_0_0 (module-name)

  • A note on the tags (i.e. the argument to the -r option in the cvs commands listed above): If HEAD is used as a tag, you will get the newest latest source code. This, however, will most likely not build since development is going on there. See http://tools.openoffice.org#CWS for a description of the development process with child workspaces and Environment Information System for the current child workspaces and milestones.




Generating the Build Environment and Build Tools

The configure script to check/prepare the build environment. It checks that all software, hardware, and system requirements for the build are satisfied, and creates a configuration file called LinuxIntelEnv.Set that is used to set all necessary build environment variables. See the example below.

This configuration file is created in the SRC_ROOT directory. A top-level makefile script makefile.mk and the script bootstrap from the config-office directory are moved into SRC_ROOT as well. This is due to technical reasons: The SRC_ROOT directory in the cvs tree can only hold directories. On the other hand, the top-level makefile.mk should logically be placed in the top-level directory SRC_ROOT. The cvs tree holds these files in config_office and configure copies them up.

If you are running a compiler with a non-standard name or location make sure that the environment variables CC and CXX point to your c and c++ compiler. (This can also be used to to use ccache to reduce your compile time.) 

export CC=/your/path/to/gcc
export CXX=/your/path/to/g++

To run the configure script, type the following command:

$SRC_ROOT> cd config_office
config_office> ./configure

There are a number of options that you can use with the configure script. To display these options, type the following command: 

config_office> ./configure --help

After running configure, you have to continue in a tcsh shell: 

$SRC_ROOT> tcsh

To create the dmake make utility that is needed for the build of OpenOffice.org type the following command: 

$SRC_ROOT> ./bootstrap

Now source the configuration file which sets all environment variables: 

$SRC_ROOT> source LinuxIntelEnv.Set

Don't forget to run 

$SRC_ROOT> rehash

afterwards.

If you experiment with the newest sources from the cvs-tree, mind that updates to the configure process may not happen via updates of configure (the script file) but via the files configure.in and set_soenv.in. The configure script itself is created from configure.in using the autoreconf command. The perl script set_soenv is created when you run configure from set_soenv.in.

If you need to modify or create a correct configure you would run commands like the following: 

$SRC_ROOT> cd config_office
config_office> cvs update configure.in
config_office> autoreconf
To update the configure script. If you only use code from the snapshot releases on the web, you don't need to be concerned about this.


Build Instructions

Building a Full Build of the Office Suite

Now you are ready to build OpenOffice.org. To build the entire suite, all you have to do (after having created the environment as described above) is to run dmake from the top-level directory. This may take several hours. 
$SRC_ROOT> dmake

If you wish to control the build more you can perform a build with local install sets or tarballs.

  • instsetoo_native will create rpm's or the actual delivery package for your platform.
  • instsetoo will create a single tar file containing the build however it is deprecated.
	cd $SRC_ROOT
	cd instetoo_native
	build --all

To clean up a previous build you can delete all output directories with

   rm -rf */unxlngi4.pro

If you decide to rebuild a module or build each module individually (mind dependencies!), you will have to use the build tool. A subsequent deliver will copy all created binaries, libraries etc. into the solver tree: 

$SRC_ROOT/(module)> build
$SRC_ROOT/(module)> deliver

The following table shows the time required to build on a system with a particular specification. You can use these details to estimate the time required to build on your system.

Architecture Intel
Processor Pentium III
Processor speed 600 MHz
RAM 256 MB
Hard disk 4 GB IDE
Time (for 1.x series) ~12 h

Note that using ccache can reduce your compile times and dramatically reduce recompile times.







Building a Project with Debug Information

To rebuild a complete project with debug information, remove all object files by removing the unxlngi4.pro directory. Then run build with the debug option set to true: 

$SRC_ROOT/(module)> rm -rf unxlngi4.pro
$SRC_ROOT/(module)> build debug=true



Instructions to Build an Installation Set

The build process (started with a top-level dmake or build --all in $SRC_ROOT/instsetoo_native) will create an installation sets in English. A simple build in $SRC_ROOT/instsetoo_native will also create the installation sets, provided all other modules are already built.

If you have built an installation set earlier and want to re-build it, please delete the local outpath first: 

$SRC_ROOT/instsetoo_native> rm -rf unxlngi4.pro

The English installation set will be located at $SRC_ROOT/instsetoo_native/unxlngi4.pro/OpenOffice/install/en-US. Execute the setup binary to install: 

$SRC_ROOT> cd instsetoo_native/unxlngi4.pro/OpenOffice/install/en-US
en-US> ./setup
The en-US in the path names indicates that the localization is American English. This value corresponds to the language tags defined by RFC 1766 (Tags for the Identification of Languages). The German installation set will be located in a de subdirectory. This scheme holds true for all localizations you may have chosen explicitly (see next section Building Localized Versions of OpenOffice.org).

For a network installation, use the -net option to setup. Details on the network installation process can be found at http://installation.openoffice.org/proposals/netinstall.html in the installation project webpage.

For information on creating an automated installation script and create a response file.




Building Localized Versions of OpenOffice.org

Running the configure script with the --with-lang option will introduce the build of additional language resources. This switch accepts one or more RFC 1766 language tags as arguments, unfortunately not all languages are supported. Check the value of the completelangiso macro in $SRC_ROOT/solenv/inc/postset.mk for all the currently supported language tags.

Example: --with-lang="de fr" enables the build of the localized german and french version.

The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages.




Building Localized Language Packs

If you build additional localized languages it is possible to generate Language Packs that contain only the changes needed to add the additional language to an OpenOffice.org of a different language.

The following commands will generate language packs languages that were specified with the --with-lang switch during the configure phase. Note that you can only build the language packs after you have build the complete office with all selected languages. 

$SRC_ROOT> cd instsetoo_native/util; dmake ooolanguagepack