Apache OpenOffice Wiki - User contributions [en]

Documentation/DevGuide/OfficeDev/Frame-Controller-Model Paradigm in OpenOffice.org

2025-03-22T20:52:55Z

Ardovm: Ardovm ha spostato la pagina Documentation/DevGuide/OfficeDev/Frame-Controller-Model Paradigm in OpenOffice.org a Documentation/DevGuide/OfficeDev/Frame-Controller-Model Paradigm in Apache OpenOffice: Title was changed fom OOo to AOO, links were changed, but this page was not renamed

#REDIRECT [[Documentation/DevGuide/OfficeDev/Frame-Controller-Model Paradigm in Apache OpenOffice]]

Documentation/DevGuide/OfficeDev/Frame-Controller-Model Paradigm in Apache OpenOffice

2025-03-22T20:52:55Z

{{Documentation/DevGuide/OfficeDevTOC
|OfficeDev2a=block
|OfficeDevFramework=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/OfficeDev/Framework API
|NextPage=Documentation/DevGuide/OfficeDev/Frames
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/OfficeDev/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Frame-Controller-Model Paradigm in {{AOo}}}}

The well-known Model-View-Controller (MVC) paradigm separates three application areas: document data (''model''), presentation (''view'') and interaction (''controller''). {{AOo}} has a similar abstraction, called the Frame-Controller-Model (FCM) paradigm. The FCM paradigm shares certain aspects with MVC, but it has different purposes; therefore, it is best to approach FCM independently of MVC. The model and controller in MVC and FCM are quite different things.

The FCM paradigm in {{AOo}} separates three application areas: document object (''model''), screen interaction with the model (''controller'') and controller-window linkage (''frame'').

* The model holds the document data and has methods to change these data without using a controller object. Text, drawings, and spreadsheet cells are accessed directly at the model.
* The controller has knowledge about the current view status of the document and manipulates the screen presentation of the document, but not the document data. It observes changes made to the model, and can be duplicated to have multiple controllers for the same model.
* The frame contains the controller for a model and ''knows'' the windows that are used with it, but does not have window functionality.

The purpose of FCM is to have three exchangeable parts that are used with an exchangeable window system:

It is possible to write a new controller that presents an existing model differently without changing the model or the frame. A controller depends on the model it presents; therefore, a new controller for a new model can be written.

Developers can introduce new models for new document types without taking care of the frame and underlying window management system. However, since there is no default controller, it is necessary to write a suitable controller also.

By keeping all window-related functionality separate from the frame, it is possible to use one single frame implementation for every possible window in the entire {{AOo}} application. Thus, the presentation of all visible components is customized by exchanging the frame implementation. At runtime you can access a frame and replace the controller, together with the model it controls, by a different controller instance.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Office Development]]

Documentation/Building Guide AOO/Step by step Linux

2024-12-24T16:03:06Z

Ardovm: /* OpenSUSE Leap */ Not a draft any more, and cherry-picks on AOO41X are not necessary since Nov 2024.

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-IPC-Cmd \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==

Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel libnsl-devel perl-Archive-Zip zip

If you plan to build Debian (.deb) archives for distribution:
$ sudo zypper in dpkg fakeroot

The AOO41X branch only compiles as-is since November 2024.
In order to compile the code from an earlier date, two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2024-12-24T09:49:04Z

Ardovm: /* OpenSUSE Leap */ update list of required packages

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-IPC-Cmd \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==
{{DraftPage|EN}}
Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel libnsl-devel perl-Archive-Zip zip

If you plan to build Debian (.deb) archives for distribution:
$ sudo zypper in dpkg fakeroot

The AOO41X branch does not compile as-is. Two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apach OpenOffice binaries legal for commecial use?

2024-10-27T20:24:36Z

Ardovm: Ardovm ha spostato la pagina Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apach OpenOffice binaries legal for commecial use? a Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apache OpenOffice binaries legal for commercial use?: Fix typo in page title

#REDIRECT [[Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apache OpenOffice binaries legal for commercial use?]]

Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apache OpenOffice binaries legal for commercial use?

2024-10-27T20:24:36Z

{{DISPLAYTITLE: Are {{AOo}} binaries legal for commercial use?}}

<section begin=question/>
Are {{AOo}} binaries legal for commercial use?
<section end=question/>

<section begin=answer/>
Yes they can be used in a commercial or business setting with no licensing fees.
<section end=answer/>

[[Category:Documentation/FAQ/ProjectLevel/BusinessLicense]]

Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apache OpenOffice binaries legal for commercial use?

2024-10-27T20:21:52Z

Ardovm: Fix typos

Documentation/FAQ/ProjectLevel/BusinessLicense

2024-10-27T19:22:02Z

Ardovm: Minor edit to regenerate DynamicPageList

[[Category:Documentation/FAQ/ProjectLevel]]
{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Business & License Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Business & License Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/ProjectLevel/BusinessLicense
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

== See Also ==
[https://www.apache.org/licenses/LICENSE-2.0 Apache License Version 2.0]
[https://www.apache.org/foundation/license-faq.html Apache Foundation Frequent Questions about ALv2]

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/BusinessLicense/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

Documentation/FAQ/ProjectLevel/BusinessLicense/Where Can I Get More Information on the Licenses?

2024-10-27T19:20:49Z

Ardovm: Fix typo in category

{{DISPLAYTITLE: Where Can I Get More Information on the License?}}

<section begin=question/>
Where can I get more information on the license?
<section end=question/>

<section begin=answer/>
For more information visit our [http://www.openoffice.org/license.html license page]
<section end=answer/>

[[Category:Documentation/FAQ/ProjectLevel/BusinessLicense]]

Documentation/FAQ/ProjectLevel/BusinessLicense/Can I sell and otherwise distribute Apache OpenOffice?

2024-10-27T19:20:27Z

Ardovm: Fix typo in category

{{DISPLAYTITLE: Can I sell and otherwise distribute Documentation/AOO?}}

<section begin=question/>
Can I sell and otherwise distribute {{AOo}}?
<section end=question/>

<section begin=answer/>
Yes, as long as you comply with the terms of [http://www.apache.org/licenses/LICENSE-2.0.html Apache License version 2]
<section end=answer/>

[[Category:Documentation/FAQ/ProjectLevel/BusinessLicense]]

NL/Documentation/FAQ/ProjectLevel/BusinessLicense

2024-10-27T19:19:13Z

Ardovm: Fix DynamicPageList

[[Category:NL/Documentation/FAQ/ProjectLevel]]
{{NL/Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project vragen over Zakelijk en licentie}}

De FAQ's doorzoeken: <googlefaq/>

Deze lijst is gesorteerd op populariteit. De meest populaire FAQ's staan bovenaan. Maar kijk ook eens onderaan om nieuwe items te ontdekken.

<DynamicPageList>

category=NL/Documentation/FAQ/ProjectLevel/BusinessLicense
ordermethod=none
order=descending
replaceintitle=/NL.*\//,
secseparators=<br>

</DynamicPageList>

== Zie ook ==
[https://www.apache.org/licenses/LICENSE-2.0 Apache License Version 2.0]<br />
[https://www.apache.org/foundation/license-faq.html Apache Foundation Frequent Questions about ALv2]

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Een nieuw item voor FAQ's toevoegen===
<inputbox>
bgcolor=#EEE
type=create
default=NL/Documentation/FAQ/ProjectLevel/BusinessLicense/<FAQ_TITLE>
preload=NL/Documentation/FAQ_Template
buttonlabel=Nieuwe FAQ toevoegen
break=no
</inputbox>
'''Instructies'''
* '''Stel geen vragen''' hier, maar '''geef antwoorden'''.
* Als u '''een vraag wilt stellen''', ga dan naar het [https://forum.openoffice.org/nl/forum/ Gebruikersforum].
* Vervang het gedeelte ''<FAQ_TITLE>'' in het invoervak hierboven door de titel die u aan het item voor de FAQ wilt geven en klik op '''Nieuwe FAQ toevoegen'''
</td></tr></table>

Documentation/FAQ/ProjectLevel/BusinessLicense/Are Apache OpenOffice binaries legal for commercial use?

2024-10-27T19:17:36Z

Ardovm: Fix typo in category

{{DISPLAYTITLE: Are {{AOo}} binaries legal for commecial use?}}

<section begin=question/>
Are {{AOo}} binaries legal for commecial use?
<section end=question/>

<section begin=answer/>
Yes they can be used in a commercial or buisness setting with no licensing fees.
<section end=answer/>

[[Category:Documentation/FAQ/ProjectLevel/BusinessLicense]]

Category:Documentation/FAQ/ProjectLevel/BusinessLicense

2024-10-27T19:17:06Z

Ardovm: Ardovm ha spostato la pagina Category:Documentation/FAQ/ProjectLevel/BuisnessLicense a Category:Documentation/FAQ/ProjectLevel/BusinessLicense senza lasciare redirect: Fix typo

[[Category:Documentation/FAQ]]

Documentation/FAQ/ProjectLevel/BusinessLicense/Can I sell and otherwise distribute Apache OpenOffice?

2024-10-27T19:15:02Z

Ardovm: Restore typo as it involves the whole category

Documentation/FAQ/ProjectLevel/BusinessLicense/Can I sell and otherwise distribute Apache OpenOffice?

2024-10-27T19:12:47Z

Ardovm: Fix typo in category

Documentation/Building Guide AOO/Step by step Linux

2024-04-26T19:20:14Z

Ardovm: /* CentOS 7 and Fedora 19 for AOO 4.2.x and later */ add Perl package required by new OpenSSL

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-IPC-Cmd \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==
{{DraftPage|EN}}
Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel libnsl-devel

The AOO41X branch does not compile as-is. Two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2023-11-29T22:31:35Z

Ardovm: /* OpenSUSE Leap */ Add build dependency

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==
{{DraftPage|EN}}
Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel libnsl-devel

The AOO41X branch does not compile as-is. Two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2023-11-29T22:20:23Z

Ardovm: /* OpenSUSE Leap */ add build dependency

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==
{{DraftPage|EN}}
Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel

The AOO41X branch does not compile as-is. Two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2023-11-29T22:18:34Z

Ardovm: Add paragraph about OpenSUSE

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==
{{DraftPage|EN}}
Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant

The AOO41X branch does not compile as-is. Two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

User:Jeanweber

2022-06-21T08:14:16Z

Ardovm: Remove reference to outdated web site

[[image:jeanweber.jpg|right]]

[mailto:jeanweber@apache.org Jean Hollis Weber] joined the OpenOffice.org community in 2002. From 2003 she was the lead editor at [http://odfauthors.org ODFAuthors] (formerly OOoAuthors), the group that produced the user guides. In January 2009 she became Co-Lead of the OpenOffice.org [http://documentation.openoffice.org Documentation Project].

Jean is a retired technical writer and editor with many years of experience with companies including IBM Australia. She is the author of numerous books, including the award-winning ''Is the Help Helpful? Writing online help that meets your users' needs'' and several books about OpenOffice.org.

Jean's websites include the [http://jeanweber.com/newsite/ Technical Editors' Eyrie].

Documentation/Building Guide AOO/Step by step with a Docker Container

2022-01-15T20:57:07Z

Ardovm: Fixed commands

{{DISPLAYTITLE:Step by step building guide with a Docker Container}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Docker Containers. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This page focuses on docker container. The goal is to provide a simple to create Build environment to build the Linux Version of Apache OpenOffice (R).

= Prerequisite to this guide =
You need to have a normal docker installation on your system and a git instance installed.

= Building your Docker image =
You need the Dockerfile for building the docker image.

Create a build folder on your host, and put the file into that folder. We assume here that the folder is /workspace/docker
$ cd /workspace/docker
$ wget https://svn.apache.org/repos/asf/openoffice/devtools/build-scripts/4.2.0/containers/linux/Dockerfile
$ docker build -t aoo_centos .

= Building Apache OpenOffice (R) =
== Getting the Code ==
$ mkdir /workspace/AOO
$ cd /workspace/AOO
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git .

== Starting the image and adding the source code ==
$ docker run -ti -v /workspace/AOO:/workspace/AOO aoo_centos

== Configure ==
See the buildscript at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/

<!--
== bootstrap ==

== build AOO ==

= The dockerfile explained =
--!>

Documentation/Building Guide AOO/Step by step with a Docker Container

2022-01-15T20:55:27Z

Ardovm: /* Building your Docker image */ Dockerfile URL from SVN repository

{{DISPLAYTITLE:Step by step building guide with a Docker Container}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Docker Containers. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This page focuses on docker container. The goal is to provide a simple to create Build environment to build the Linux Version of Apache OpenOffice (R).

= Prerequisite to this guide =
You need to have a normal docker installation on your system and a git instance installed.

= Building your Docker image =
You need the Dockerfile for building the docker image.

Create a build folder on your host, and put the file into that folder. We assume here that the folder is /workspace/docker
$ cd /workspace/docker
$ wget https://svn.apache.org/repos/asf/openoffice/devtools/build-scripts/4.2.0/containers/linux/Dockerfile .
$ docker build -t aoo_centos

= Building Apache OpenOffice (R) =
== Getting the Code ==
$ mkdir /workspace/AOO
$ cd /workspace/AOO
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git .

== Starting the image and adding the source code ==
$ docker run -ti -v /workspace/AOO:/workspace/AOO aoo_centos

== Configure ==
See the buildscript at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/

<!--
== bootstrap ==

== build AOO ==

= The dockerfile explained =
--!>

Documentation/Building Guide AOO/Step by step with a Docker Container

2022-01-07T10:04:22Z

Ardovm: /* Building your Docker image */ add -t parameter to indicate image name

{{DISPLAYTITLE:Step by step building guide with a Docker Container}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Docker Containers. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This page focuses on docker container. The goal is to provide a simple to create Build environment to build the Linux Version of Apache OpenOffice (R).

= Prerequisite to this guide =
You need to have a normal docker installation on your system and a git instance installed.

= Building your Docker image =
You need the Dockerfile for building the docker image.

Create a build folder on your host, and put the file into that folder. We assume here that the folder is /workspace/docker
$ cd /workspace/docker
$ wget dockerfile@address TBD .
$ docker build -t aoo_centos

= Building Apache OpenOffice (R) =
== Getting the Code ==
$ mkdir /workspace/AOO
$ cd /workspace/AOO
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git .

== Starting the image and adding the source code ==
$ docker run -ti -v /workspace/AOO:/workspace/AOO aoo_centos

== Configure ==
See the buildscript at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/

<!--
== bootstrap ==

== build AOO ==

= The dockerfile explained =
--!>

Documentation/Building Guide AOO/Step by step with a Docker Container

2022-01-07T10:03:12Z

Ardovm: Minor reformatting

{{DISPLAYTITLE:Step by step building guide with a Docker Container}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Docker Containers. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This page focuses on docker container. The goal is to provide a simple to create Build environment to build the Linux Version of Apache OpenOffice (R).

= Prerequisite to this guide =
You need to have a normal docker installation on your system and a git instance installed.

= Building your Docker image =
You need the Dockerfile for building the docker image.

Create a build folder on your host, and put the file into that folder. We assume here that the folder is /workspace/docker
$ cd /workspace/docker
$ wget dockerfile@address TBD .
$ docker build

= Building Apache OpenOffice (R) =
== Getting the Code ==
$ mkdir /workspace/AOO
$ cd /workspace/AOO
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git .

== Starting the image and adding the source code ==
$ docker run -ti -v /workspace/AOO:/workspace/AOO aoo_centos

== Configure ==
See the buildscript at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/

<!--
== bootstrap ==

== build AOO ==

= The dockerfile explained =
--!>

IRC Communication

2021-08-03T20:03:48Z

Ardovm: /* IRC info */ Change Freenode into Libera.Chat

[[OpenOffice.org]] project uses [[wikipedia:Internet Relay Chat|IRC]] for direct and immediate online communication. Please see [http://www.google.com/calendar/embed?src=k4bgtc8bil9cs2a77lhh1r998g%40group.calendar.google.com google calendar] for schedules.

== IRC Network ==

Since June 2021 we changed to ''Libera.chat

=== Libera.chat (irc.libera.chat) ===

{|
| [irc://irc.libera.chat/Openoffice #openoffice] || Generic channel, please use this for all questions related to Apache OpenOffice
|-
| [irc://irc.freenode.net/openoffice-de #openoffice-de] || Channel to meet germanophone speaking people from project Apache OpenOffice
|}

=== Freenode (irc.freenode.net) ===

!!! This channel is deprecated !!!

{|
| [irc://irc.freenode.net/Openoffice.org #Openoffice.org] || Users and generic channel, please use this for questions related to OOo usage
|-
| [irc://irc.freenode.net/dev.openoffice.org #dev.openoffice.org] || Channel for developers discussing building and extending OpenOffice.org
|-
| [irc://irc.freenode.net/specs.openoffice.org #specs.openoffice.org] || Specifications and development processes
|-
| [irc://irc.freenode.net/qa.openoffice.org #qa.openoffice.org] || [[:Category:Quality Assurance|QA]] channel
|-
| [irc://irc.freenode.net/ooo-api #ooo-api] || [[API]] channel related to API programming, SDK, developer documentation (formerly api.openoffice.org).
|-
| [irc://irc.freenode.net/chart2.openoffice.org #chart2.openoffice.org] || [[Chart2]] channel
|-
| [irc://irc.freenode.net/ooonlc #ooonlc] || [[NLC|Native Language]] Talk Room
|-
| [irc://irc.freenode.net/debian-oo #debian-oo] || Debian OO.o packaging channel (This is now on irc.oftc.net)
|-
| [irc://irc.freenode.net/openoffice.org-de #openoffice.org-de] || Germanophone channel
|-
| [irc://irc.freenode.net/openoffice.org-it #openoffice.org-it] || Italian channel
|-
| [irc://irc.freenode.net/openoffice.org-pl #openoffice.org-pl] || Polish channel
|-
| [irc://irc.freenode.net/openoffice.org-zh #openoffice.org-zh] || Chinese channel
|-
| [irc://irc.freenode.net/cs.openoffice.org #cs.openoffice.org] || Czech channel (serves also Slovak users)
|-
| [irc://irc.freenode.net/openoffice.et #openoffice.et] || Estonian channel
|-
| [irc://irc.freenode.net/fr.openoffice.org #fr.openoffice.org] || Francophone channel
|-
| [irc://irc.freenode.net/nl.openoffice.org #nl.openoffice.org] || Dutch channel
|-
| [irc://irc.freenode.net/ru.openoffice.org #ru.openoffice.org] || Russian channel
|-
| [irc://irc.freenode.net/OOoES #OOoES] || Spanish Channel
|-
| [irc://irc.freenode.net/broffice.org #broffice.org] || Brazilian Channel
|-
| [irc://irc.freenode.net/dba.openoffice.org-de #dba.openoffice.org-de] || Germanophone channel to help with the Base-Modul of OpenOffice.org
|-
| [irc://irc.freenode.net/ooo_macport #ooo_macport] || Native [[Mac OS X]] (Aqua) port of OpenOffice.org developer channel
|-
| [irc://irc.freenode.net/ooo-ext #ooo-ext] || [[Extensions]] channel
|-
| [irc://irc.freenode.net/ux.openoffice.org #ux.openoffice.org] || [[User Experience]] channel
|-
| [irc://irc.freenode.net/odftoolkit #odftoolkit] || [[ODF_Toolkit|ODF Toolkit]] channel (discussing strategies, next steps, ...)
|-
| [irc://irc.freenode.net/education.openoffice.org #education.openoffice.org] || [[Education_Project|Education Project]] channel (everything about Education project, ...)
|-
| [irc://irc.freenode.net/openoffice.org-docs #openoffice.org-docs] || [[Documentation|Documentation Project]] channel
|}

== IRC Network: HanIRC (irc.hanirc.org) ==

{|
| [irc://irc.hanirc.org/openoffice #openoffice] || Korean channel
|}

== IRC info ==

* [http://irchelp.org/irchelp/new2irc.html New to IRC info]
* Make sure you register your nick with [[wikipedia:Libera Chat|Libera.Chat]], just follow the [https://libera.chat/guides/registration instructions]
* If you like [[wikipedia:X-Chat|X-Chat]] but have to use windows sometimes, here is a free win32 [http://www.silverex.org/download/ version ]
* A client for Mac OS X is [http://colloquy.info/ Colloquy]
* An extension for Firefox is [https://addons.mozilla.org/en-US/firefox/addon/16 ChatZilla]
* To create a new channel:
<pre>
/join #new-channel-oo
/msg chanserv register #new-channel-oo [password]
/msg chanserv access #new-channel-oo add [who_should_autoop_there_1] [level]
/msg chanserv access #new-channel-oo add [who_should_autoop_there_2_and_more] [level]
/msg chanserv set #new-channel-oo guard on
/msg chanserv level #new-channel set autoop [level-for-autoop]
</pre>

== Who is Who? ==

A list of people & accounts is available: [[DomainDeveloper]]
[[Category:Website]]

Education Project/Welcome en

2021-08-03T20:00:08Z

Ardovm: /* IRC */ Point to general channel on Libera.Chat

{{DISPLAYTITLE: Welcome}}

This is the logo for the Education project :

[[Image:LaMouette-Degree_mini.jpg]]

Author : Ben Bois ( ben at hooboo dot com )

== '''What is Education project ?''' ==

In OpenOffice.org, everything is project. And all websites starts using the rule :
http://$(project).OpenOffice.org

e.g. : http://education.openoffice.org

At this point in time, this is an incubator project. This means that we have just begun and there is a lot more to do before attaining the status of a Project.

'''... we need you !'''

== '''The Idea''' ==

The idea : '''create a strong bridge between Educational World and OpenOffice.org Project''', leading to
* synergy
* visibility
* and progress for all

== '''Our Mission''' ==

'''In 3 points'''

- '''Provide a place for OpenOffice.org users, in Education context''': discuss about adapt OpenOffice.org to your pedagogy, your needs ..etc (all levels of Education are concerned )

- '''Provide and promote tools''' adapted to pedagogical use, around OpenOffice.org

- '''Write code together''' : we can teach you everything about OpenOffice.org code and how add your: just go ahead

== '''Objectives writing code together''' ==

* welcome students
** propose them methodology ( find documentation)
** teach them (for basic knowledge and autonomy)
** work shops ( like the practice in ClassRoom )
** read and explain code together
** mentor students (drive them to the right solution, and raise their autonomy)
** project management and guidance

* work for synergy between professional world and university professors / teachers
** project setup
** start research and development oriented projects

=== <div align="left" style="color:red; font-size:18px">'''Education Project Effort '''</div> ===

Idea based on [[Efforts | Efforts]]

<div align="left" style="color:blue; font-size:18px">''' [[Education_Project/Effort | ==> Click Here to visit Education Project Effort wiki page]]''' </div>

<br>

== '''The Benefits''' ==

* '''For the Teachers'''

** Visibility
** Keep the contact with the reality of Industrial Projects
** direct contacts with high level projects
** Share their knowledge with other Teachers and Professional

* '''For the Students'''

** Have some guidance in their project works is motivating
** Work directly with high level Professional developers is motivating
** They contribute for a real and exciting Project
** Visibility and credibility : good conributions, and open sourced code are a promise for a good job in the future
** Can valorize their experience

* '''The OpenOffice.org Project''' will ...
** win new developers, and contributors
** progress because new eyes means new visions, and new solutions
** contribute to a social effect: share the knowledge
** involve more professors and students to participate, and collaborate for OpenSource project

== OUR SPONSORS ==

(any candidate ? :-) )

== PARTNERS are non profit Organisations ==

If you are a school, and want to support us, please add you in the list :

University of Technology of Belfort Montebeliard : http://www.utbm.fr [6]

== What can you do to help us ? ==

DO YOU HAVE A SUGGESTION ? WANT TO DO OR PROPOSE SOMETHING ?

Just do it !! ...and see below what fits at the best to your needs !

== CONTRIBUTE ==

Student, Professor, Developer ( C++ , Objective-C , C, Python, everything website) , sponsor or volunteer, you certainly can help us, and feel welcome in Education project !!

With us, you can learn :

* how the source code for OpenOffice.org is organized so that you can develop effectively
* which tools are used in OpenOffice.org
* how to build OpenOffice.org for your Operating System
* how a new feature implementation is accepted and scheduled
* how the QA is managed
* how the component or module you want to understand and possibly contribute to functions
* what to do if you want to add something
* what to do if you want to create an extension
* how to define applications for your students adapted to OpenOffice.org
* how to become a Domain Developer for OpenOffice.org project

Last: we are interested to provide courses about OpenOffice.org. All suggestions are welcome !

== DONATE ==

Soon you'll be able to help the project by making individual or corporate donations to the project with the aim of furthering the development of infrastructure to sustain the project longevity.

== SEARCH TOOLS about EDUCATION and OpenOffice.org ==

We do provide tools using OpenOffice.org and adapted to your pedagogy.
Every time we can, we try to provide

== PROVIDE US EXPERTISE ==

Are you using OpenOffice.org in your courses/studies ? Please :

- let us know which School you represent
- what you did
- provide us pedagogical methods adapted to teaching

== Where start ? ==
=== JOIN THE PROJECT ===

Thanks to respect the steps below :

Go at http://education.openoffice.org <= exactly this site ...

'''If you don't have a login, create one is mandatory ( on top right)'''

'''Validate all the steps allowing to connect yourself to the Education Project''' ( confirm the subscription mail and so on )

'''Log you in''' with the password you have choosen,

'''=> Click on Membership, then on Request project membership / role'''

'''Finaly, click on "Submit Request" and wait for a project Lead to accept your pending request'''

That's it :-)

=== MAILING LISTS ===

Just subscribe to dev@education.openoffice.org (highly advised) at : http://education.openoffice.org/servlets/ProjectMailingListList [3]

Archives are extremely important, and are usefull to retrieve something being discussed long time ago.

=== WEB ===

Fixed informations are on Education project website : [1] http://education.openoffice.org

You'll find : links for tools, links for exchange area FIXME ( add some of them )

=== WIKI ===

Alive informations stand in our wiki : [2] http://wiki.services.openoffice.org/wiki/Education_Project

Localized wiki pages :

French page :

Switzerland ( german at this time) : [3] http://wiki.services.openoffice.org/wiki/Project_EDUCATION-ch

(other ) : TODO

=== IRC ===

Discuss with us !

We have an IRC channel and you can meet us for true:

Server is irc.libera.chat
Channel is #openoffice

See you :-)

=== REGULAR IRC MEETINGS ===

We hold regular IRC meetings, and all logs are public.

You'll find them here : http://wiki.services.openoffice.org/wiki/Previous_Education_Meetings_logs [4]

If you want to join, please have a look at : http://wiki.services.openoffice.org/wiki/Education_IRC_meetings [5]

=== LINKS (summary ) ===
* [http://education.openoffice.org The main website]
* [http://wiki.services.openoffice.org/wiki/Education_Project The Wiki]
* [http://education.openoffice.org/servlets/ProjectMailingListList Mailing list]
* [http://wiki.services.openoffice.org/wiki/Previous_Education_Meetings_logs Logs] of previous Education IRC Meetings
* [http://wiki.services.openoffice.org/wiki/Education_IRC_meetings Education IRC meetings]
* [http://www.utbm.fr University of Technology of Belfort Montbeliard]
* [http://projects.openoffice.org/incubator.html Incubator projects]

=== EDUCATION Team ===

'''[[Education_Project/Team | Click Here to know who we are, and more]]'''

[[Category:Education]]

Development

2021-08-03T19:57:21Z

Ardovm: Suggest general IRC channel on Libera.Chat instead of dedicated channel on Freenode

__TOC__
== Getting started with Apache OpenOffice development ==

You are at the start of a long, but very exciting journey! Apache OpenOffice is a large and inclusive project. No matter what your interests are, there is always a place for you here. There are many ways to get started, but the easiest one is to:

=== Get the source code and start building ===
Build you own OpenOffice so that you are able to modify things
{{Tip| The [[Documentation/Building_Guide_AOO|Building Guide]] will walk you through this.}}

=== Fix a bug or an annoyance ===
Pick up your favorite bug/annoyance, and try to fix that. Read how to [[Contributing_Patches|Contribute a patch]] via Issue Tracker.
{{Tip| Browse [[https://bz.apache.org/ooo/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&field0-0-0=votes&type0-0-0=greaterthan&value0-0-0=50&order=issues.votes%20desc,%20issues.priority,%20issues.issue_type Top voted issues]] or review our [[To-Dos]] list that presents the key issues of interest to the core components}}

=== Contribute more ===
When you see that hacking AOO pleases you, it's time to look for bigger tasks, get in contact on [[IRC]] or on the [http://openoffice.apache.org/mailing-lists.html development mailing list]. The list is friendly and supportive; the people want to help.

== Create an extension ==
Extensions are easy to write and fun to see in action. You can add features that millions of others will use by using Java, Python, StarBasic, or JavaScript. Find more on [[Extensions_development|Extension development]] wiki page. The OpenOffice.org UNO component model is quite extensive and can be daunting at first. To help you, there is a comprehensive [[Documentation/DevGuide|Development Guide]]. The easiest way to get started is by using the plugins for [[OpenOffice_NetBeans_Integration|Netbeans]] and for [[OpenOffice_Eclipse_Integration|Eclipse]]. Plus, you can get help from the [[http://openoffice.apache.org/mailing-lists.html#api-mailing-list-public API mailing list]].

== Development resources ==
* [[Documentation/Building Guide AOO|Building Guide]]
* [[Documentation/DevGuide|Development Guide]]
* [http://opengrok.adfinis-sygroup.org/source/ Opengrok] - source browser
* [http://api.openoffice.org OpenOffice.org API]
* [https://issues.apache.org/ooo/ Bugtracker]
* [[Environment Variables]] - a description of handy environment variables used at runtime
* [[Source code directories| A description of the source directories]]
* [[Localization for developers]]
* [[Build Bootstrapping]]

== Further reading ==
* [[IRC Communication|Meet the team on IRC]]
* [[Using_Cpp_with_the_OOo_SDK|Using C++ with OOo SDK]]
* [[Tutorials]] - hacker tutorials to get the hang of the code
* [[Hacking]]
* [[Debugging]] - for when it all goes wrong
* [[Contributing Patches]] - for when you have something to fold back
* [[Commit Rights]] - An overview of how to attain commit rights, and what to do with them once you get them
* [[Tips]] - misc. hints & tips.
* [[Compiler versions used by port maintainers and release engineers]]
* [[Writing warning-free code|Warning-free Code]] and [[Writing correct Cplusplus|Correct C++]]

== Education project ==
{{Tip|If you don't find the instructions in the Wiki good enough to guide you or if you are interested in some aspect that is not covered, feel free to subscribe and ask on the [mailto:dev_at_openoffice.org dev@openoffice.org] mailing list. See [[Communication]] for more infromation on how get in touch with the OpenOffice.org project.}}

{{Tip|Another solution is to contact the [[Education Project]], which aims to find future OpenOffice.org developers, mainly students, who are discovering OpenOffice.org Project. Get in touch on IRC: [ircs://irc.libera.chat/openoffice #openoffice on Libera.Chat]}}

{{Tip|On the [[Education_ClassRoom|ClassRoom]] page, you will find more information about the essentials. For example [[Education_ClassRoom/Practice|Practice]], or [[Education_ClassRoom/Previous_Logs|IRC Meetings Logs]] we did as "ClassRooms".}}

----
<references/>
[[Category:Development]][[Category:Build System]][[Category:SCM]]

User:Ardovm/macOS

2021-07-18T12:55:15Z

Ardovm: Update

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install getopt p5-archive\* p5-lwp-protocol-https p5-mozilla-ca perl5 pkgconfig git subversion
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

Work in progress: synchronize this page with the build script

User:Ardovm/macOS

2021-07-09T19:03:57Z

Ardovm: /* MacOS Catalina */ port openssl10

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install getopt openssl10 p5-archive\* p5-lwp-protocol-https p5-mozilla-ca perl5 pkgconfig subversion
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

User:Ardovm/macOS

2021-07-08T18:57:09Z

Ardovm: Update ports

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install getopt p5-archive\* p5-lwp-protocol-https p5-mozilla-ca perl5 pkgconfig subversion
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

User:Ardovm/macOS

2021-06-26T19:53:41Z

Ardovm: Perl must come from macports

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install p5-archive\* subversion getopt perl5 p5-mozilla-ca p5-lwp-protocol-https
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

User:Ardovm/macOS

2021-06-26T19:37:59Z

Ardovm: /* MacOS Catalina */ p5-mozilla-ca

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install p5-archive\* subversion getopt p5-mozilla-ca
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

User:Ardovm/macOS

2021-06-26T13:54:16Z

Ardovm: Ant installation directory

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install p5-archive\* subversion getopt
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)
$ cd /usr/local/share/java/ && sudo ln -s apache-ant-1.9.13 apache-ant-1.9

User:Ardovm/macOS

2021-06-26T13:52:40Z

Ardovm: getopt

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install p5-archive\* subversion getopt
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)

User:Ardovm/macOS

2021-06-26T10:33:37Z

Ardovm: Apache ant

=MacOS Catalina=
Purpose: build AOO41X

# Download Xcode 12.0.1 and install it
# Download Xcode 7.3.1
# Download https://github.com/devernay/xcodelegacy
$ curl -OL https://raw.githubusercontent.com/devernay/xcodelegacy/master/XcodeLegacy.sh
$ chmod +x XcodeLegacy.sh
$ ./XcodeLegacy.sh -osx1011 buildpackages
$ sudo ./XcodeLegacy.sh -osx1011 install
# Install macports
# Install necessary ports:
$ sudo port install p5-archive\* subversion
# Install Apache Ant 1.9.13 into '''/usr/local/share/java/''' (will make a subdirectory with the version name)

User:Ardovm/macOS

2021-06-26T10:20:55Z

Ardovm: Update ports list

User:Ardovm/macOS

2021-06-26T10:03:07Z

Ardovm: WIP: notes about macOS

Documentation/Building Guide AOO/Building on MacOsX

2021-06-25T19:58:12Z

Ardovm: /* Requirements for Xcode 7 (or newer) */ fix broken link to autoconf sources

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]
[[Category:Build_System]]

__TOC__

= Overview =

Building Apache OpenOffice from source code follows the
platform independent [[Documentation/Building_Guide_AOO| building guide]]
when the build requirements outlined below are fulfilled.

= General build requirements =

Please see the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] page.

= Mac specific requirements for building AOO 4.1 (and older) =

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 7 or later.
| Use the App Store application to get and install it. For Xcode 7 (or newer) some [[#XCODE7|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 7 or newer. That most recent compatible SDK is 10.11; SDKs for 10.12 and above are not supported due to Apple's deprecation of Quicktime, which is needed for vcl.
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

<div id="XCODE5">

= Requirements for Xcode 7 (or newer) =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|-
| autoconf
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/autoconf/autoconf-2.69.tar.gz
tar xvjf autoconf-2.69.tar.gz
pushd autoconf-2.69
./configure --prefix=/usr/local
make
sudo make install
popd
|}

Alternatively, you can also install via MacPorts
</div>

<div id="OSX109">

= OSX 10.9 (or newer) specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}

Alternatively, you can also install via MacPorts

</div>

= Reference Build System =

The reference build system for AOO 4.1.x and 4.2.x is a macOS VM with 8x3.33 cores and 24GB of RAM. The AOO 4.1.x VM is running macOS 10.13 (High Sierra) with Xcode 11, but requires the MacOSX10.11.sdk (SDK 10.12 and above do not support QuickTime, which is a requirement for AOO 4.1.x). We use [https://github.com/devernay/xcodelegacy xcodelegacy] to install the required SDK into Xcode (You could also use Xcode7 directly). This setup is also configured to allow us to product the "Official" Community builds for macOS/OSX and supports versions as old as 10.9 (''Mavericks''). On this platform it takes 2-3 hours for a full build.

For AOO 4.2.x and later, we are running macOS 10.15 (Catalina) and Xcode 12.2. This allows us to continue to build for older platforms (as old as OS X '''10.9'''! ) but also sign our releases for Apple Gatekeeper compatibility and deprecate the requirement for a QuickTime-compatible SDK.

If building for your own setup, some of the below may not be required.

== 3rd Party Requirements ==

=== Installed in /usr/local: ===

* Apache ant 1.9.9 (or later)
* dmake 4.13.0 / https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz (./configure --prefix=/usr/local)
* epm 5.0.0 / https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz (./configure --prefix=/usr/local)
* openssl 1.0.2l (or later) (no-shared)
* libxml2-2.9.6 (or later) (--prefix=/usr/local --enable-shared=no --without-iconv)
* libxslt-1.1.31 (or later) (--prefix=/usr/local --enable-shared=no)
* pkg-config 0.29.2 (or later) (--prefix=/usr/local)
* jdk-7u80-macosx-x64

You will notice that the recommended version of epm for OS X is 4.3 (or later); This is because previous versions required the long deprecated '''''PackageMaker''''' application (as well as '''''PackageMaker''''' being installed in a hardcoded location). Starting with epm 4.3, the official OS X ''pkgbuild'' utility is supported, removing the need for '''''PackageMaker'''''. AOO specific versions of epm and dmake are available [https://github.com/jimjag/ on Github].

=== Installed in /opt/local via MacPorts: ===

* autoconf (symlinked to /usr/local/bin)
* gnutar (symlinked to /usr/local/bin)
* perl5 (symlinked to /usr/local/bin)
* subversion
* git

You will also need to install the required Perl packages noted in the general build page since OS X does not include them by default. If you don't want to mix System and User modifications, you can use MacPorts/HomeBrew to install Perl and use this user-land version for these extra packages.

== Local Environment Requirements: ==
* Make sure that ''/usr/local/bin'' is in your ''PATH''.
* Set and export JAVA_HOME (export JAVA_HOME=$(/usr/libexec/java_home -v 1.7))
* Ensure that these env variables are also correct (and exported):
** ANT_HOME=/usr/local/share/java/apache-ant
** LIBRARY_PATH=/usr/local/lib
** C_INCLUDE_PATH=/usr/local/include
** CPLUS_INCLUDE_PATH=/usr/local/include

== Configure and Build ==

{| class="prettytable" border="1" width="100%"
| Run this command in a terminal
./configure \
--enable-verbose \
--with-openldap \
--enable-category-b \
--enable-bundled-dictionaries \
--enable-wiki-publisher \
--without-junit \
--with-jdk-home="$JAVA_HOME" \
--with-ant-home="$ANT_HOME" \
--with-epm=/usr/local/bin/epm \
--with-dmake-path=/usr/local/bin/dmake \
--without-stlport \
--with-package-format="dmg" \
--disable-systray \
--with-alloc=internal \
--with-lang="${LANGS}"
|}

The ''LANGS'' env variable should contain the list of languages you wish to build for (e.g. "en-GB en-US es eu fi").

Continue with the standard, platform independent build instructions. Copies of the official build scripts (and their corresponding ''config.log'' outputs) can be found [https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ here].

Documentation/Building Guide AOO/Step by step Windows

2021-05-04T19:42:39Z

Ardovm: /* Windows 7, Windows 8.1, Windows 10 */ Link to GDI+ download

{{DISPLAYTITLE:Step by step building guide on Windows}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Windows. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Windows 7, Windows 8.1, Windows 10 =

'''Complete requirements found at [https://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO#General_Build_Requirements General Build Requirements] and [https://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Building_on_Windows Building on Windows].'''

This is a '''sample''' step-by-step guide - check the complete requirements and report on dev@openoffice.apache.org, if problems with this step-by-step guide occur.

*Install Cygwin, '''32-bit version'''
**Browse to [https://www.cygwin.com https://www.cygwin.com] and click on the setup-x86.exe link to download the 32-bit version (the latest Cygwin DLL known to work is 3.1.7-1) or use [https://www.cygwin.com/setup-x86.exe this direct link]. Note: "make" has to be downgraded to version 4.2.1-2 for building AOO up to version 4.1.7.
**Run the installer and click through the questions
**On the "Choose A Download Site" select a nearby download server
**Expect a "Setup Alert" dialog box on the first cygwin install on the computer: click OK to close it
**On the page that allows you to select additional packages select: <br /><br /> From the '''Archive''' category: <pre>zip, unzip</pre> From the '''Devel''' category: <pre>autoconf, gperf, gcc-g++, bison, flex, patch, git, make</pre> From the '''Net''' category: <pre>rsync</pre>From the '''Perl''' category: <pre>perl, perl-XML-SAX-Expat, perl-Archive-Zip, perl-LWP-Protocol-https, perl-XML-parser, perl-libwww-perl, perl-Digest-SHA, perl-Net-SSLeay</pre>As a shortcut you can install everything needed with one command:<pre>setup-x86.exe -P zip -P unzip -P autoconf -P gperf -P gcc-g++ -P bison -P flex -P patch -P git -P make -P rsync -P perl -P perl-XML-SAX-Expat -P perl-Archive-Zip -P perl-LWP-Protocol-https -P perl-XML-parser -P perl-libwww-perl -P perl-Digest-SHA -P perl-Net-SSLeay</pre><i>(If you prefer to install packages with a Linux kind of touch, you can skip selecting the packages and instead select just the package <b>lynx</b> (enter lynx in the Search box and select the lynx entry in the Web/Default section). You would then install the other packages from the cygwin command line using lynx as explained ahead. However, selecting the packages from the Cygwin interface is recommended.)</i>
**Click Next to finish package selection.
**Click Next to resolve dependencies.
**After installation is finished click the Finish button to close the dialog.

*Start Cygwin bash in a terminal

::In Windows 7 and later you can just type "cygwin" into the Start Menu search bar and then click on the Cygwin App. Or you can:
::*Press {{key|Windows|R}}
::*Type "C:\cygwin\Cygwin.bat" (if that's the path you installed Cygwin to)
::*Hit Return.
:::<i>(If you haven't installed the necessary packages from the Cygwin interface yet because you would prefer to install them using lynx from the Cygwin command line, then you should do so now. First install <b>apt-cyg</b> from the Github repository:)<pre>cd /cygdrive/c/temp</pre>(or any other temporary directory of your choice)<pre>lynx -source rawgit.com/transcode-open/apt-cyg/master/apt-cyg > apt-cyg
chmod +x apt-cyg
mv apt-cyg /usr/local/bin/</pre>Use <b>apt-cyg</b> to install missing cygwin packages:<pre>apt-cyg install perl zip unzip gperf autoconf rsync gcc-g++ bison flex patch git make</pre>(You must also provide to install the missing perl packages, for example with "cpan -i Archive::Zip LWP::UserAgent LWP::Protocol XML::Parser" etc. however there can be some dependency conflicts, the recommended method is installing the packages from the cygwin interface)</i>

* Replace symlinked awk with copy of gawk.exe:<pre>rm /usr/bin/awk
mv /usr/bin/gawk.exe /usr/bin/awk.exe</pre>Note that if the <code>rm</code> command fails then the <code>mv</code> is not necessary.

* Install Java, '''32-bit version'''
::Choose between JDK or OpenJDK. Versions 1.7 and 1.8 are known to work.
::(We need the 32-bit version because JNI requires the JVM's bitness to match the C/C++ bitness).

* Install Apache Ant
**Browse to https://ant.apache.org/bindownload.cgi
**Chose a mirror near you.
**Download the zip archive (currently that is apache-ant-1.9.15-bin.zip or apache-ant-1.10.8-bin.zip).<br /> Note that Apache Ant 1.10.x will only work with Java 8.
**Open downloaded archive in file explorer and unzip it to a location of your choice, eg <code>c:\</code>. Note that <code>C:\Program Files (x86)</code> will not work due to problems of quoting the spaces and parentheses.

* Install Microsoft Windows SDK for Windows 7 and .NET Framework 3.5. SP1 (recommended by Microsoft. Note: later versions of the Windows SDK will not work. AOO can not be built with MSVC 2010 or 2012 - MSVC 2008 is needed and is found in the Windows 7 SDK)
** Browse to http://www.microsoft.com/en-us/download/details.aspx?id=3138.
** Download winsdk_web.exe and run the web installer. You can use the default values in the installation dialog, except when prompted with the installation path use a path that has no spaces or parentheses (e.g. "C:\Microsoft_SDKs\Windows\v7.0"), because otherwise the build process will choke on those spaces or parentheses.
** Alternatively download the iso image http://www.microsoft.com/en-us/download/details.aspx?id=18950. Burn it to a dvd or unzip it.

* Download MS Visual C++ 2008 SP1 Redistributable Package (x86)
** https://www.microsoft.com/en-us/download/details.aspx?id=26368 (There have been security updates, which are not included in older versions)
**Download files vcredist_x86.exe and vcredist_x64.exe<br /> We need both 32 and 64-bit versions because we build 64-bit shell extensions. If you download the most recent version of Apache OpenOffice and unpack it, you will find the files vcredist_x86.exe and vcredist_x64.exe in folder redist. You can use them as well.

* Optional: Install DirectX SDK (for graphics hardware support in the slide show)
** Browse to http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=6812
** Download and run DXSDK_Jun10.exe. Choose to install to a custom path, and use a path that has neither spaces nor parentheses (e.g. <code>C:\Microsoft_DirectX_SDK_June_2010</code>), because otherwise the build will not be able to parse the path and will choke on the spaces or parentheses. <i>(If you receive an S1023 error towards the end of the installation, [https://support.microsoft.com/it-it/kb/2728613 the fix is simple]. The issue occurs because a newer version of the Visual C++ 2010 Redistributable is present on the computer. The June 2010 DirectX SDK installs version 10.0.30319 of the Visual C++ Redistributable. To resolve this issue, you must uninstall all versions of the Visual C++ 2010 Redistributable before installing the June 2010 DirectX SDK. You may have one or more of the following products installed: Visual C++ 2010 Redistributable x86, Visual C++ 2010 Redistributable x64. You can use Add or Remove Programs in Control Panel to uninstall the products. Or, you can run the following commands from an administrator command prompt: <pre>MsiExec.exe /passive /X{F0C3E5D1-1ADE-321E-8167-68EF0DE699A5} 
MsiExec.exe /passive /X{1D8E6291-B0D5-35EC-8441-6616F567A0F7}</pre> and then run the DirectX SDK installer. After installing the June 2010 DirectX SDK, you may then reinstall the most current version of the [http://www.microsoft.com/download/details.aspx?id=26999 Visual C++ 2010 Redistributable Package].)</i>

* Optional: Install Windows Driver Kit 7.1.0 (for enabling activex)
** Download [http://www.microsoft.com/en-us/download/details.aspx?id=11800 WDK 7.1.0] (is an ISO image). Cannot use later versions of Windows Driver Kit because they do not have ATL which is needed to build AOO with ActiveX. (I recommend to download using Internet Explorer, otherwise the install may fail a Windows Authenticity test, whereas this does not happen using Internet Explorer to download the ISO image.)
** Mount the ISO image and install.

* Optional: Install NSIS installer (for creating the EXE installer)
** Browse to [https://sourceforge.net/projects/nsis/files/ https://sourceforge.net/projects/nsis/files/]
** Download and run the installer (note that versions of NSIS >= 3.* are only compatible with branch 4.1.3 or later! otherwise you will have to install at most [https://sourceforge.net/projects/nsis/files/NSIS%202/2.51/nsis-2.51-setup.exe/download NSIS 2.51]). Recommended to install to custom location, choose a path without any spaces (e.g. "C:\NSIS").
** For Asian languages (ja, ko, zh-CN, zh-TW) the language files have to be edited, otherwise the graphics in the first installer windows don't fit. In "{NSISDIR}\Contrib\Language files\Japanese.nlf" (Korean.nlf, TradChinese.nlf, SimpChinese.nlf accordingly) change: <pre>Font and size - dash (-) means default
{font-name}
{font-size}</pre> to:<pre>Font and size - dash (-) means default
-
-</pre>

* Optional: Install the MozillaBuild tools. These are needed to build the <b>NSS</b> ("Network Security Services") module. Download from [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ here]. Install to a custom path without any spaces, such as <code>C:\mozilla-build</code>. MozillaBuild tools version 3.0 or newer require a 64-bit Windows. When building on 32-bit Windows it is recommended to use version 2.2.0.

* Get AOO source code. You can use the source release or check out from SVN. Build from source release if you want to build OpenOffice once but don't want to contribute patches. If you will contribute patches, you need to generate them against an actual version of trunk. In this case check out from SVN to be able to rebase before generating patches. You can work with subversion or with git-svn. Do not use a tool that changes line endings, such as the default configuration of TortoiseSVN. NOTE: Do not place the source directory under the Cygwin file system. This means that placing it, for example, at '/home/aoo/source' is not recommended.

::; Source release:
::* Browse to http://www.openoffice.org/download/other.html#tested-sdk and locate the table row that starts with "Source code"
::* Download source code in an archive format of your choice (note that tar.bz2 is typically smaller than tar.gz and zip)
::* Optional: Verify the archive - following given link or instructions.
::* Unpack source (in cygwin-terminal). Use the file name exactly as downloaded.<pre>cd /tmp
tar -xjf <download-location>/<downloaded-source-release.tar.bz2>
cd <unpacked-source>/main
</pre>Do not use Windows unpacker, they might cause access right problems.

::; Checkout from SVN using subversion :
::*<i>(If you haven't installed the subversion package from the cygwin interface, please do so now by re-running the cygwin installer, or if you used lynx and apt-cyg then:)<pre>apt-cyg install subversion</pre></i>
::*Start with creating a parent directory for the source code: <pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo-trunk
cd aoo-trunk/main</pre>

::; Checkout from Gitbox using git (Since 2019-08-03):
::*<i>(If you haven't installed the git package from the cygwin interface, please do so now by re-running the cygwin installer, or if you used lynx and apt-cyg then:)<pre>apt-cyg install git</pre></i>
::*Start with creating a parent directory for the source code: <pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache Git repository<pre>git clone https://gitbox.apache.org/repos/asf/openoffice.git aoo
cd aoo/main</pre>

::; Checkout from SVN using git-svn :
::*<i>(If you haven't installed git and git-svn from the cygwin interface, please do so now by re-running the cygwin installer, or if you used lynx and apt-cyg then:)<pre>apt-cyg install git git-svn</pre></i>
::*Get the actual revision number from https://svn.apache.org/viewvc/openoffice/trunk/, e.g. 1234567
::*Create an empty directory and change to it, e.g.<pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>git svn clone --revision 1234567:HEAD https://svn.apache.org/repos/asf/openoffice/trunk
cd trunk/main</pre>

* Remember the source path (this is optional, it makes for an easy reference):<pre>SourceMain=`pwd`</pre> [Why? I have not used it. [[User:Regina|Regina]] ([[User talk:Regina|talk]]) 21:42, 24 February 2013 (UTC)]
:[Added explanation above [[User:Andre|Andre]]]

* Optional: Get dbghelp.dll (for using the <code>--enable-dbgutil</code> configure option)
** This dll is part of MS Visual Studio. If you do not have it installed, download and install "Visual Studio Community" from https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
** Copy file to <code>main/external/dbghelp</code>. Use Windows file manager or in cygwin terminal<pre>cp /cygdrive/c/Program\ Files\ $x86$/Microsoft\ Visual\ Studio\ 9.0/Common7/IDE/dbghelp.dll $SourceMain/external/dbghelp</pre>

* Copy vcredist_x86.exe and vcredist_x64.exe (see above) to main/external/vcredist.
** Use Windows file manager or in cygwin terminal<pre>cp <download-location>/vcredist_x86.exe $SourceMain/external/vcredist
cp <download-location>/vcredist_x64.exe $SourceMain/external/vcredist</pre>

* Get GDI+ redistributable:
**Browse to https://www.microsoft.com/en-us/download/details.aspx?id=18909
**Download [https://web.archive.org/web/20190714055850/http://download.microsoft.com/download/a/b/c/abc45517-97a0-4cee-a362-1957be2f24e1/WindowsXP-KB975337-x86-ENU.exe WindowsXP-KB975337-x86-ENU.exe]
**Run WindowsXP-KB975337-x86-ENU.exe
**Enter a temporary path (eg c:\temp\gdiplus) in the dialog and click OK to extract files
**Copy gdiplus.dll to main/external/gdiplus<pre>cp /cygdrive/c/temp/gdiplus/asms/10/msft/windows/gdiplus/gdiplus.dll $SourceMain/external/gdiplus/</pre>
** Remove the temporary path<pre>rm -fr /cygdrive/c/temp/gdiplus</pre>

* Get msvcr100.dll:
**We need the 32-bit dll (version 10.0.40219.325), available from: https://www.microsoft.com/en-US/download/details.aspx?id=26999<pre>cp /cygdrive/c/Windows/System32/msvcr100.dll $SourceMain/external/msvcp100</pre>

* Make sure that you are in the main source directory:<pre>cd $SourceMain</pre>

* Run autoconf to create the configure script:<pre>autoconf</pre>

* Call configure
** For those paths that do have spaces, use the cygpath tool to get a shortened version without any spaces, which you can then use in the configuration directives without any trouble (adapt paths as necessary):<pre>$ cygpath -m -s "C:\Program Files (x86)\Java\jdk1.8.0_73" 
C:/PROGRA~2/Java/JDK18~1.0_7 
$ cygpath -m -s "C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC" 
C:/PROGRA~2/MI1DCA~1.0/VC</pre>Run configure (again adapt paths as necessary)<pre>SDK_PATH="/cygdrive/c/Microsoft_SDKs/Windows/v7.0"
./configure \
 --with-frame-home="$SDK_PATH" \
 --with-psdk-home="$SDK_PATH" \
 --with-midl-path="$SDK_PATH/bin" \
 --with-ant-home="/cygdrive/c/apache-ant-1.9.15" \
 --with-jdk-home="C:/PROGRA~2/Java/JDK18~1.0_7" \
 --with-csc-path="C:/Windows/Microsoft.NET/Framework/v3.5" \
 --with-cl-home="C:/PROGRA~2/MI1DCA~1.0/VC" \
 --with-asm-home="C:/PROGRA~2/MI1DCA~1.0/VC/bin" \
 --with-dmake-url="https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz" \
 --disable-pch \
 --disable-atl \
 --disable-activex \
 --disable-nss-module \
 --without-junit</pre>If you have installed the optional DirectX SDK then you can add the switch:<pre> --with-directx-home="C:/Microsoft_DirectX_SDK_June_2010"</pre>If you have installed Windows Driver Kit 7.1.0 and would like to build with ATL and ActiveX functionality then remove the <code>--disable-activex</code> and the <code>--disable-atl</code> directives, and add the atl home directives: <pre> --with-atl-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/atl71 \
 --with-atl-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/ATL/i386 \
 --with-mfc-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/mfc42 \
 --with-mfc-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/Mfc/i386</pre>If you have installed NSIS you can use the relative directive <pre> --with-nsis-path="C:/NSIS"</pre>If you have installed MozillaBuild tools you can use the relative switch:<pre> --with-mozilla-build="/cygdrive/d/mozilla-build"</pre>You may also enable a few more switches (used for official releases: --enable-win-x64-shellext):<pre> --enable-win-x64-shellext \
 --enable-wiki-publisher \
 --enable-category-b \
 --enable-bundled-dictionaries</pre>and if you would like to build for different locales you can use the lang switch (in this example, for English United States and for Italian):<pre> --with-lang="en-US it"</pre>If you have copied over the dbghelp.dll and would like these extra features you can enable the debug switch:<pre> --enable-dbgutil</pre>
*Finish configuration and download missing external source tarballs and extensions<pre>./bootstrap</pre>
* Include the configured environment<pre>source winenv.set.sh</pre>
* Build<pre>cd instsetoo_native/
build --all</pre>Depending on your computer this will take one or more hours to finish. You may want to experiment with the -P options for multi process builds to reduce the build time. <pre>build --all -P<m> -- -P<n></pre> tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

* Install<br/>There are three options:
*# Regular install with integration into Windows.<br/>This allows only one instance of AOO to be installed.
*#* Start setup.exe and click through dialog:<br/><pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe</pre>
*#* Apache OpenOffice can be started via the Windows start menu.
*# Install without integration into Windows.<br/>This allows several instance of AOO, based on the same version, to be installed side by side.<br/>It still requires Administrator permissions.
*#* Start <code>setup.exe</code> with option <code>-a</code>:<br/><pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe -a</pre>
*#* Enter an installation path into the dialog and click through the dialog to finish installation.
*#* Start AOO by running<br/><pre><installation-path>/program/soffice.exe</pre>
*# Unpack archive without installation.<br/>This does not require Administrator permissions
*#* Go to installation directory:<br/><pre>cd <installation-target></pre>
*#* Unzip archive:<br/><pre>unzip $SourceMain/instsetoo_native/wntmsci12.pro/Apache_OpenOffice/msi/install/en-US/Apache_OpenOffice_4.1.4_Win_x86_install-arc_en-US.zip</pre>
*#* Start AOO by running:<br/><pre>./Apache_OpenOffice_4.1.4_Win_x86_install-arc_en-US/program/soffice.exe</pre>
::: (Change the version number in the file name to match the version you built)

== Build with Cygwin 64-bit ==

{{Note | Building AOO with Cygwin 64-bit will only work with trunk and the 4.2.x branch, it will '''not''' work with any 4.1.x branch!}}

* Install Cygwin, '''64-bit version'''
** Browse to [https://www.cygwin.com https://www.cygwin.com] and click on the setup-x86_64.exe link to download the 64-bit version (the latest Cygwin DLL known to work is 3.1.7-1) or use [https://www.cygwin.com/setup-x86_64.exe this direct link]. Note: For some older revisions "make" has to be downgraded to version 4.2.1-2 to build AOO from trunk or AOO42X.
** Run the installer and click through the questions
** On the "Choose A Download Site" select a nearby download server
** Expect a "Setup Alert" dialog box on the first cygwin install on the computer: click OK to close it
** On the page that allows you to select additional packages select: <br /><br /> From the '''Archive''' category: <pre>zip, unzip</pre> From the '''Devel''' category: <pre>autoconf, gperf, gcc-g++, bison, flex, patch, git, make</pre> From the '''Net''' category: <pre>rsync</pre>From the '''Perl''' category: <pre>perl, perl-XML-SAX-Expat, perl-Archive-Zip, perl-LWP-Protocol-https, perl-XML-parser, perl-libwww-perl, perl-Digest-SHA, perl-Net-SSLeay</pre>As a shortcut you can install everything needed with one command:<pre>setup-x86_64.exe -P zip -P unzip -P autoconf -P gperf -P gcc-g++ -P bison -P flex -P patch -P git -P make -P rsync -P perl -P perl-XML-SAX-Expat -P perl-Archive-Zip -P perl-LWP-Protocol-https -P perl-XML-parser -P perl-libwww-perl -P perl-Digest-SHA -P perl-Net-SSLeay</pre>
** Click Next to finish package selection.
** Click Next to resolve dependencies.
** After installation is finished click the Finish button to close the dialog.

* Start Cygwin bash in a terminal and follow all the steps for 32-bit Cygwin up to and including './configure' with relative parameters
** Finish configuration and download missing external source tarballs and extensions<pre>./bootstrap</pre>
** Include the configured environment<pre>source winenv.set.sh</pre>
** Build<pre>cd instsetoo_native/
build --all</pre>Depending on your computer this will take one or more hours to finish. You may want to experiment with the -P options for multi process builds to reduce the build time. <pre>build --all -P<m> -- -P<n></pre> tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Documentation/Building Guide AOO

2021-01-30T20:01:05Z

Ardovm: /* Configuration and bootstrapping */ mention non product build (checkpoint save)

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

These instructions are for the "'''trunk'''" branch, that is the current development release. If you are looking for instructions to build specific releases, refer to section [[#Step-by-Step Building Guide for Different Platforms]] as well.

Here is the short version for the brave and impatient:
# <code>git clone https://gitbox.apache.org/repos/asf/openoffice.git</code><br />or<br /><code>git clone https://github.com/apache/openoffice.git</code>
# Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
# Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
# Wait for an hour or more (The build can take up to 3 hours.)
# Enjoy

The compilation can be automated by the [http://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts].

The detailed description below gives a broader introduction into the build process and explains for the various steps.

{{Note|This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice.}}
* How to use cache

{{SeeAlso|EN|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

Since August 2019, the source code is available as Git repository at https://gitbox.apache.org/repos/asf/openoffice.git, or https://github.com/apache/openoffice.

Check it out with

git clone https://gitbox.apache.org/repos/asf/openoffice.git
or
git clone https://github.com/apache/openoffice.git

Git is the preferred way for developers to obtain the source code. After cloning the repository as described above, you will be able to track the current development branches and also quickly switch to the latest official releases ("tags"). For example, to check out the source code for {{AOO}} 4.1.8 issue the command:

git checkout tags/AOO418-GA

If a full-blown repository clone is not necessary, for example because you just want to download and build a specific release, more details about how to check out source code can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the version control overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in <code>main/sw/</code>. More information on the organization of the modules in the source code directories [[Source_code_directories | here]].
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

Official releases are built using [http://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts] to automate the process.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html JDK 1.7] or higher. [http://openjdk.java.net/ OpenJDK] is supported as well.
For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] or JDK 1.8 is recommended.
The JDK's bitness must match the target platform's, eg. when building for Win32, use a 32 bit JDK even if compiling on Win64.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages

* Archive::Zip
* XML::Parser
* LWP::UserAgent
* Digest::SHA
* Digest::MD5
* LWP::Protocol::https

On Linux, use whenever possible your package manager to install the required modules. On Windows, use cygwin's setup-x86.exe or setup-x86_64.exe.

The name of packages varies depending on the system:

{| class="wikitable" border="1"
|-
! Perl Module
! CentOS/Fedora
! Debian/Ubuntu
! Windows/cygwin
|-
| Archive::Zip
| perl-Archive-Zip
| libarchive-zip-perl
| perl-Archive-Zip
|-
| XML::Parser
| perl-XML-Parser
| libxml-parser-perl
| perl-XML-Parser
|-
| LWP::UserAgent
| perl-libwww-perl
| libwww-perl
| perl-libwww-perl
|-
| Digest::SHA
| perl-Digest-SHA
| perl
| perl-Digest-SHA
|-
| Digest::MD5
| perl-Digest-MD5
| perl
| perl
|-
| LWP::Protocol::https
| perl-LWP-Protocol-https
| liblwp-protocol-https-perl
| perl-LWP-Protocol-https
|}

On some rather old systems, ''LWP::Protocol::https'' is installed in the same package as ''LWP::UserAgent''; in this case, you need to install further dependencies in order to use ''LWP::UserAgent'' with the HTTPS protocol with no errors; on CentOS 5, for example, you need to install the ''Crypt::SSLeay'' module, provided by the ''perl-Crypt-SSLeay'' package.

On Mac OS X, bootstrap may fail to download external dependencies from HTTPS URLs (you may get an error with a message like "Can't verify SSL peers without knowing which Certificate Authorities to trust"), even if configure found all required modules; in this case, install the ''Mozilla::CA'' module using cpan.

On CentOS, ''perl-Digest-SHA'' might be only provided through the EPEL repository.

The prefered way to install Perl modules is using your system's package manager; alternatively, and as last resort, Perl modules can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appears accepts commands. Install missing modules with
install <module-name>
Find more details [https://wiki.openoffice.org/wiki/CPAN_install here].<sup>5</sup>

|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the MozillaBuild tools<sup>2</sup> are needed to build the NSS module. MozillaBuild tools version 3.0 or newer require a 64-bit Windows. When building on 32-bit Windows it is recommended to use version 2.2.0. They can be obtained [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [https://tools.openoffice.org/unowinreg_prebuild/680/ pre-built unowinreg.dll] (see NOTE)
Required for building the ODK which is included in the build unless disabled. This file is required for non-Windows builds. Without this file, configure will try to set up cross-compiling with windows.
NOTE: Not for windows. Required on all non-windows platforms. Download by directly saving unowinreg.dll into /main/external/unowinreg from the link provided above, or by using wget:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll https://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
|-
|}

'''Notes:'''
# The NSS module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ MozillaBuild tools]. Install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. To see all configure options for your system, type:
configure --help

A typical configuration call starts like this --
./configure \
--with-dmake-url=https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz \
--with-epm-url=https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> 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 <code>[https://github.com/apache/openoffice/blob/trunk/main/solenv/inc/langlist.mk solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

To build with symbolic generation, add option
--enable-symbols
This would allow you to work with debugging symbols in gdb.

Another useful option for interactive debugging features is dbgutil. Add option,
--enable-dbgutil
for this feature. This will result in a [[Non Product Build]]. Also see the Debugging information on this page.

By default the result binaries will be packaged in the default format used by your OS/Distribution. Using 'installed' for package format puts OpenOffice into your ''installset'' directory (browse down ../installed/install). This will save you time for testing since you can then directly run OpenOffice from this area.

Add option
--with-package-format="installed"

This will speed up development process since it skipped packaging. In some cases, packaging rips the debugging symbol so this would be necessary for symbolic generation. '''NOTE:''' Additional package format options will be ignored with the "installed" option.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details of the rat scan.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacci
| MacOSXX64Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Details about creating installation sets can be found [[Building_installation_packages|here]].

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may find it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>.

You may want to erase the output of a previous compilation. In some cases a new compilation will not work correctly unless the old output is removed.

{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

==Build Cleanup==
In the event that you want to change configuration parameters used for building, you will probably need to "clean" your build output tree before starting again.

To do this, navigate to the "main" directory, then source your environment shell script as you did for building:

<tt>source <shell-script-name></tt>

then do:

dmake clean

=Step-by-Step Building Guide for Different Platforms=

This section is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code. A more thorough explanation of what the individual steps do and why they are necessary can be found in the other sections of this document.

The guides limit themselves to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step guide for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]]

==[[Documentation/Building Guide AOO/Step by step Linux|Linux]]==

==[[Documentation/Building Guide AOO/Step by step Windows|Windows]]==

==[[Documentation/Building Guide AOO/Building on MacOsX|Mac OS X]]==

= Building Apache OpenOffice with an IDE =
== [[OpenOffice and Eclipse|Building with Eclipse]] ==

= Additional Build Resources =
It can be useful to build an older version of {{AOO}} on newer build environments, for example in order to regression test a bug in the latest version.

Older source code may need some integrations, that are described on this page: [[Building old versions]].

== [[Debugging|Debugging]] ==

[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

User:Ardovm/QA

2021-01-20T07:42:35Z

Ardovm: /* Notes on release testing */

==Notes on release testing==

Developer builds:
* https://www.openoffice.org/qa/testcase/
* [[QA/test_automation_guide]]
* [[QA/TestCases/#AOO_3.4_General_Testing_Test_Cases]]

Release candidates:
* http://www.apache.org/legal/release-policy.html
* https://s.apache.org/openoffice-416-tests

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T20:13:25Z

Ardovm: /* Obtain the source code */ Pointer to the Building guide

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

=Obtain the source code=

This chapter lists the commands for cloning the {{AOO}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO

2021-01-14T20:08:39Z

Ardovm: /* Getting the source */ A little more detail on Git

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

These instructions are for the "'''trunk'''" branch, that is the current development release. If you are looking for instructions to build specific releases, refer to section [[#Step-by-Step Building Guide for Different Platforms]] as well.

Here is the short version for the brave and impatient:
# <code>git clone https://gitbox.apache.org/repos/asf/openoffice.git</code><br />or<br /><code>git clone https://github.com/apache/openoffice.git</code>
# Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
# Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
# Wait for an hour or more (The build can take up to 3 hours.)
# Enjoy

The compilation can be automated by the [http://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts].

The detailed description below gives a broader introduction into the build process and explains for the various steps.

{{Note|This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice.}}
* How to use cache

{{SeeAlso|EN|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

Since August 2019, the source code is available as Git repository at https://gitbox.apache.org/repos/asf/openoffice.git, or https://github.com/apache/openoffice.

Check it out with

git clone https://gitbox.apache.org/repos/asf/openoffice.git
or
git clone https://github.com/apache/openoffice.git

Git is the preferred way for developers to obtain the source code. After cloning the repository as described above, you will be able to track the current development branches and also quickly switch to the latest official releases ("tags"). For example, to check out the source code for {{AOO}} 4.1.8 issue the command:

git checkout tags/AOO418-GA

If a full-blown repository clone is not necessary, for example because you just want to download and build a specific release, more details about how to check out source code can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the version control overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in <code>main/sw/</code>. More information on the organization of the modules in the source code directories [[Source_code_directories | here]].
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

Official releases are built using [http://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts] to automate the process.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html JDK 1.7] or higher. [http://openjdk.java.net/ OpenJDK] is supported as well.
For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] or JDK 1.8 is recommended.
The JDK's bitness must match the target platform's, eg. when building for Win32, use a 32 bit JDK even if compiling on Win64.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages

* Archive::Zip
* XML::Parser
* LWP::UserAgent
* Digest::SHA
* Digest::MD5
* LWP::Protocol::https

On Linux, use whenever possible your package manager to install the required modules. On Windows, use cygwin's setup-x86.exe or setup-x86_64.exe.

The name of packages varies depending on the system:

{| class="wikitable" border="1"
|-
! Perl Module
! CentOS/Fedora
! Debian/Ubuntu
! Windows/cygwin
|-
| Archive::Zip
| perl-Archive-Zip
| libarchive-zip-perl
| perl-Archive-Zip
|-
| XML::Parser
| perl-XML-Parser
| libxml-parser-perl
| perl-XML-Parser
|-
| LWP::UserAgent
| perl-libwww-perl
| libwww-perl
| perl-libwww-perl
|-
| Digest::SHA
| perl-Digest-SHA
| perl
| perl-Digest-SHA
|-
| Digest::MD5
| perl-Digest-MD5
| perl
| perl
|-
| LWP::Protocol::https
| perl-LWP-Protocol-https
| liblwp-protocol-https-perl
| perl-LWP-Protocol-https
|}

On some rather old systems, ''LWP::Protocol::https'' is installed in the same package as ''LWP::UserAgent''; in this case, you need to install further dependencies in order to use ''LWP::UserAgent'' with the HTTPS protocol with no errors; on CentOS 5, for example, you need to install the ''Crypt::SSLeay'' module, provided by the ''perl-Crypt-SSLeay'' package.

On Mac OS X, bootstrap may fail to download external dependencies from HTTPS URLs (you may get an error with a message like "Can't verify SSL peers without knowing which Certificate Authorities to trust"), even if configure found all required modules; in this case, install the ''Mozilla::CA'' module using cpan.

On CentOS, ''perl-Digest-SHA'' might be only provided through the EPEL repository.

The prefered way to install Perl modules is using your system's package manager; alternatively, and as last resort, Perl modules can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appears accepts commands. Install missing modules with
install <module-name>
Find more details [https://wiki.openoffice.org/wiki/CPAN_install here].<sup>5</sup>

|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the MozillaBuild tools<sup>2</sup> are needed to build the NSS module. MozillaBuild tools version 3.0 or newer require a 64-bit Windows. When building on 32-bit Windows it is recommended to use version 2.2.0. They can be obtained [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [https://tools.openoffice.org/unowinreg_prebuild/680/ pre-built unowinreg.dll] (see NOTE)
Required for building the ODK which is included in the build unless disabled. This file is required for non-Windows builds. Without this file, configure will try to set up cross-compiling with windows.
NOTE: Not for windows. Required on all non-windows platforms. Download by directly saving unowinreg.dll into /main/external/unowinreg from the link provided above, or by using wget:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll https://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
|-
|}

'''Notes:'''
# The NSS module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ MozillaBuild tools]. Install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. To see all configure options for your system, type:
configure --help

A typical configuration call starts like this --
./configure \
--with-dmake-url=https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz \
--with-epm-url=https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> 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 <code>[https://github.com/apache/openoffice/blob/trunk/main/solenv/inc/langlist.mk solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

To build with symbolic generation, add option
--enable-symbols
This would allow you to work with debugging symbols in gdb.

Another useful option for interactive debugging features is dbgutil. Add option,
--enable-dbgutil
for this feature. Also see the Debugging information on this page.

By default the result binaries will be packaged in the default format used by your OS/Distribution. Using 'installed' for package format puts OpenOffice into your ''installset'' directory (browse down ../installed/install). This will save you time for testing since you can then directly run OpenOffice from this area.

Add option
--with-package-format="installed"

This will speed up development process since it skipped packaging. In some cases, packaging rips the debugging symbol so this would be necessary for symbolic generation. '''NOTE:''' Additional package format options will be ignored with the "installed" option.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details of the rat scan.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacci
| MacOSXX64Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Details about creating installation sets can be found [[Building_installation_packages|here]].

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may find it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>.

You may want to erase the output of a previous compilation. In some cases a new compilation will not work correctly unless the old output is removed.

{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

==Build Cleanup==
In the event that you want to change configuration parameters used for building, you will probably need to "clean" your build output tree before starting again.

To do this, navigate to the "main" directory, then source your environment shell script as you did for building:

<tt>source <shell-script-name></tt>

then do:

dmake clean

=Step-by-Step Building Guide for Different Platforms=

This section is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code. A more thorough explanation of what the individual steps do and why they are necessary can be found in the other sections of this document.

The guides limit themselves to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step guide for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]]

==[[Documentation/Building Guide AOO/Step by step Linux|Linux]]==

==[[Documentation/Building Guide AOO/Step by step Windows|Windows]]==

==[[Documentation/Building Guide AOO/Building on MacOsX|Mac OS X]]==

= Building Apache OpenOffice with an IDE =
== [[OpenOffice and Eclipse|Building with Eclipse]] ==

= Additional Build Resources =
It can be useful to build an older version of {{AOO}} on newer build environments, for example in order to regression test a bug in the latest version.

Older source code may need some integrations, that are described on this page: [[Building old versions]].

== [[Debugging|Debugging]] ==

[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T19:36:57Z

Ardovm: /* Preparation of the development system */ Small introduction

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

=Obtain the source code=

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <branch> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T19:32:58Z

Ardovm: Outline: two more chapters. Obtain source code and configure

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

=Obtain the source code=

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <branch> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T19:27:59Z

Ardovm: /* Setup a VM */ Explicit instructions for 32-bit CentOS 5

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare a release build.

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <branch> with the branch you want to compile e.g. AOO419 or AOO42X

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T18:22:07Z

Ardovm: /* Ubuntu 18.04 */ Merge installation of git in the previous command

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example for the 64-bit distribution.

$ wget -O /tmp/CentOS-5.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website mirror.nsc.liu.se and CentOS directory /centos-store/5.11/os/x86_64
** Partitioning: 60000M for /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively) <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare a release build.

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <branch> with the branch you want to compile e.g. AOO419 or AOO42X

Documentation/Building Guide AOO/Step by step Linux

2021-01-14T18:21:03Z

Ardovm: All this is just a preparation of the development system

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example for the 64-bit distribution.

$ wget -O /tmp/CentOS-5.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website mirror.nsc.liu.se and CentOS directory /centos-store/5.11/os/x86_64
** Partitioning: 60000M for /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively) <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare the release builds.

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

===Configure===

The scripts at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/ are used to prepare a release build.

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev

Install git
$ sudo apt-get install git

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <branch> with the branch you want to compile e.g. AOO419 or AOO42X

Talk:Documentation/Building Guide AOO/Step by step Linux

2021-01-14T18:04:52Z

Ardovm: /* Instructions about obtaining the source code */ Discussion with Pedlino

==Instructions about obtaining the source code==
Git, SVN instructions etc. would IMHO better fit [[Documentation/Building Guide AOO]] than this page, because they are not specific to Linux.
Here, we could give for granted that the sources are "somewhere", ready to be compiled.
Or, we could insert a link to the relevant section of the building guide.<br />
The only good reason (still IMHO) to insert Git commands ''here'' would be the case they are ''very'' different from the same commands under other platforms (Windows, Mac). But I have no experience on them, unfortunately. [[User:Ardovm|Ardovm]] ([[User talk:Ardovm|talk]]) 13:07, 14 January 2021 (UTC)

Sure, no problem just delete whatever you find redundant. I have no idea if they are specific to Linux. I don't build on any other platform. I would still leave the install git command because it is not included in Ubuntu 18.04 by default. --[[User:Pedlino|Pedlino]] ([[User talk:Pedlino|talk]]) 13:30, 14 January 2021 (UTC)

: But you are right in fact! If this is a step-by-step guide, we should have all steps, not just stop once we have the build system ready! I'll re-arrange the chapters to allow the next steps. [[User:Ardovm|Ardovm]] ([[User talk:Ardovm|talk]]) 18:04, 14 January 2021 (UTC)

Talk:Documentation/Building Guide AOO/Step by step Linux

2021-01-14T13:07:17Z

Ardovm: Formatting and signature