Much of the information here is outdated and refers to obsolete OOo versions.
For current information on how to build OOo, see the OOo Wiki: Building Guide
Building OpenOffice.org 2.x (680er/300er series) under Windows with tcsh
Beware! The build instructions for OpenOffice.org 1.1.x (and older) are different!
Last changes made: $Date: 2010/06/08 16:09:13 $
This document describes the requirements and actions that you need to build OpenOffice.org on Windows using Cygwin shell.
Commands you have to type on the keyboard follow this syntax throughout this document:
In this example, the script
configure is executed
in the directory
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_ROOTwill denote the directory in which the source code of OpenOffice.org is stored.
Table of Contents
- Build Requirements
- Build Instructions
- Instructions to Build an Installation Set
- Building Localized Versions of OpenOffice.org
- Building Localized Language Packs
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.
To perform a full build, you need to follow these steps:
- Get the source code, either from the download webpage (http://download.openoffice.org/next) or alternatively via a check-out from the cvs tree against a release tag, e.g. OpenOffice_3_1_0.
- Run the
configurescript to check all requirements and to create the script
- Source the
winenv.setscript to set all environment variables.
Please see the last screen from the configure script for more specific information on setting up for your platform.
- Create the build tools using
- Recompute tcsh's directory hash using
- Build typing
build --allin the
deliverin the individual modules.
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 Windows, these are as follows:
You have two options to get the source code:
Download the source code tarball
OOo_3.1.0_src_core.tar.gzin case of the 3.1 stable release.
Unpack the tarballs as follows:
> tar -xvzf OOo_3.1.0_src_core.tar.gz > cd OOO300m9
This will be $SRC_ROOT from now on. Please check the OpenOffice.org Wiki for more detailed information about the source tarballs.
Another possibility is to check out the code from the subversion tree.
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> svn / co svn://svn.services.openoffice.org/ooo/tags/OpenOffice_3_1_0 /
A note on the tags (i.e. the argument to the -r option in the cvs commands listed above): If trunk 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.
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
that is used to set all necessary build environment variables. See the example below.
This configuration file is created in the
A top-level makefile script
makefile.mk and the
bootstrap from the
are moved into
SRC_ROOT as well. This is due to technical reasons:
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
Before running configure, make sure that all needed Programs are in the system path or start configure with the appropriate command line switches.
The following should demonstrate in detail what steps have to be done to set up the environment. For this examples we assume that
the source code is in
JDK 1.4.1_02 is installed in
the Microsoft Compiler is located in
c:\Programme\Microsoft Visual Studio .NET 2003\Vc7)
the Microsoft SDK is located in
Other Shells - ExampleYou are able to enable the use of tcsh with
--with-use-shell=tcshor the use of bash with
To run the
configure script, type the following command:
$SRC_ROOT> cd config_office config_office> ./configure --with-cl-home="/cygdrive/c/Programme/Microsoft Visual Studio .NET 2003/Vc7" --with-jdk-home=/cygdrive/c/j2sdk1.4.1_02 --with-use-shell=tcsh
There are a number of options that you can use with the
script. To display these options, type the following command:
config_office> ./configure --help
configure, you have to continue in a tcsh shell:
To create the dmake make utility that is needed for the build of OpenOffice.org type the following command:
Now source the configuration file which sets all environment variables:
$SRC_ROOT> source winenv.set
Don't forget to run
If you experiment with the newest sources from the cvs-tree, mind that updates
to the configure process may not happen via updates of
(the script file) but via the files
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> autoreconfTo update the
configurescript. If you only use code from the snapshot releases on the web, you don't need to be concerned about this.
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
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
$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.
|Processor speed||1466 MHz|
|Hard Disk||160 GB 7200 RPM IDE|
|Time (for SRC680_m86)||~17 h|
To rebuild a complete project with debug information, remove all object
files by removing the
directory. Then run
build with the debug option set to true:
$SRC_ROOT/(module)> rm -rf $SRC_ROOT/(module)> build debug=true
The build process (started with a top-level
build --all in
$SRC_ROOT/instsetoo_native) will create
an installation sets in English.
will also create the installation sets, provided all other modules are
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 wntmsci10.pro
The English installation set will be located at
setup binary to install:
$SRC_ROOT> cd instsetoo_native/wntmsci10.pro/OpenOffice/install/en-US en-US> setup.exeThe 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
in the installation project webpage.
For information on creating an automated installation script and create a response file.
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
completelangiso macro in
for all the currently supported language tags.
--with-lang="de fr" enables the build of the localized german and
The environment variable
will then contain the language tags of the additional (en-US will always be build)
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