Attachment #5491 for issue #13097

View | Details | Raw Unified | Return to issue 13097
Collapse All | Expand All




<body>

<h2>
Building OpenOffice.org under <Linux>Linux</Linux><Solaris>Solaris</Solaris><Win_tcsh>Windows with tcsh</Win_tcsh><Windows>Windows with 4NT</Windows>
</h2>
<Win_tcsh><p>
The Cygwin tcsh environment is experimental, and can be used starting with
cws_srx644_ooo20030412.
</p></Win_tcsh>
<p>
This document describes the requirements and actions that you need to build 
OpenOffice.org on <Linux>Linux.</Linux><Solaris>Solaris.</Solaris><Win_tcsh>Windows using Cygwin shell</Win_tcsh><Windows>Windows.</Windows>
</p>

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

<LinuxSolarisWin_tcsh>
<p>
<pre>
<KBD>config_office> ./configure</KBD>

<p> 
In this example, the script <CODE>configure</CODE> is executed 
in the directory <CODE>config_office</CODE>.
</LinuxSolarisWin_tcsh>

<Windows>
<p>

<p>
Basically, there is the choice to build OpenOffice.org from two different 
branches: a stable branch, which results in the 1.0.x releases, or 
a less stable developer branch (latest release see
<a href="http://tools.openoffice.org/builds/index.html">here</a>).
Links to the different sources are given in the document. 
</p>

<br><p><br><p><br><p>

  <li> Get the source code, either from the download webpage
    (<a href="http://www.openoffice.org/dev_docs/source/download.html">www.openoffice.org/dev_docs/source/download.html</a>)
    or alternatively via a check-out from the cvs tree against a release tag, 
    e.g. <em>cws_srx644_ooo11beta</em>. </li>
   <LinuxSolarisWin_tcsh> 
   <li> Run the <CODE>configure</CODE> script to check all requirements and to 
     create the script</LinuxSolarisWin_tcsh> 
   <Linux><CODE>LinuxIntelEnv.Set</CODE>.</Linux><Solaris><CODE>SolarisSparcEnv.Set</CODE>.</Solaris><Win_tcsh><CODE>winenv.set</CODE>.</Win_tcsh> 
   <Windows> 
   <li> Run the <CODE>configure</CODE> script in a cygwin bash shell to 
    check all requirements and to create the script <CODE>winenv.bat</CODE>. 
  </li>
  </Windows> 
  <li> Run the 
    <Linux><CODE>LinuxIntelEnv.Set</CODE></Linux><Solaris><CODE>SolarisSparcEnv.Set</CODE></Solaris><Win_tcsh><CODE>winenv.set</CODE></Win_tcsh><Windows><CODE>winenv.bat</CODE> (under 4NT) </Windows> script to set all environment variables. 
  </li>
  <LinuxSolarisWin_tcsh> 
  <li> Create the build tools using <CODE>bootstrap</CODE>. </li>
  </LinuxSolarisWin_tcsh> 
  <li> Build typing <CODE>dmake</CODE> in <CODE>$SRC_ROOT</CODE>, or 
    <CODE>build -all</CODE> in the <CODE>instsetoo</CODE> module, or 
    <CODE>build</CODE> followed by <CODE>deliver</CODE> in the individual 

    <Linux><CODE>solver643B_linux_intel.tar.gz.</CODE></Linux> 
    <Solaris><CODE>solver643B_solaris_sparc.tar.gz.</CODE></Solaris> 
    <Windows><CODE>solver643B_win32intel.tar.gz.</CODE></Windows> 
    <Win_tcsh><CODE>solver643B_win32intel.tar.gz.</CODE></Win_tcsh> 
  </li>

  <li> Check out the modules for the project that you want to build from the 

    However, it is not possible to download individual modules there. </li>
  <li> Check out the module <CODE>config_office</CODE>. This is always necessary 
    to create the build environment. </li>
  <LinuxSolarisWin_tcsh> 
  <li> Also check out the modules <CODE>dmake, external, xml2cmp, mkdepend, sal, 
    solenv, vos, tools and rscpp</CODE>. These are required by <CODE>bootstrap</CODE> 
    (see below). </li>
  </LinuxSolarisWin_tcsh> 
  <Windows> 
  <li> Also check out the module <CODE>solenv</CODE>. </li>
  </Windows> 
  <li> Unpack the solver tarball in the <CODE>$SRC_ROOT</CODE> directory. </li>
  <LinuxSolarisWin_tcsh> 
  <li> Run the <CODE>configure</CODE> script to check all requirements and to 
    create the script 
  </LinuxSolarisWin_tcsh>
  <Linux><CODE>LinuxIntelEnv.Set</CODE>.</Linux>
  <Solaris><CODE>SolarisSparcEnv.Set</CODE>.</Solaris> 
  <Win_tcsh><CODE>winenv.set</CODE>.</Win_tcsh> 
  <Windows> 
  <li> Run the <CODE>configure</CODE> script in a cygwin bash shell to 
    check all requirements and to create the script <CODE>winenv.bat</CODE>.

  <li> Run the script 
    <Linux><CODE>LinuxIntelEnv.Set</CODE></Linux> 
    <Solaris><CODE>SolarisSparcEnv.Set</CODE></Solaris> 
    <Win_tcsh><CODE>winenv.set</CODE></Win_tcsh> 
    <Windows><CODE>winenv.bat</CODE></Windows> 
    to set all environment variables. 
  </li>
  <LinuxSolarisWin_tcsh> 
  <li> Create the build tools using <CODE>bootstrap</CODE>. </li>
  </LinuxSolarisWin_tcsh> 
  <li> Build each module against the prebuild <CODE>solver</CODE> using the <CODE>build</CODE> 
    tool, followed by <CODE>deliver</CODE>. </li>
</ol>

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

<p>
<Linux>

</ul>
</Solaris>

<WindowsWin_tcsh>
<p><b>Build Requirements</b><p>

<ul>

  <li>
    Microsoft Visual C++ Version 6 Service Pack 3. 
  </li>
</WindowsWin_tcsh>

<Windows>
  <li>
    4NT Version 2.5 or higher. You can download this from 
    <a href="ftp://jpsoft.com/4nt/">ftp://jpsoft.com/4nt/</a>.

LocalAliases = Yes
</pre>
  </li>
</Windows>

<WindowsWin_tcsh>
  <li>
    <a href="http://java.sun.com/j2se/1.3">JDK 1.3.1</a>. 
  </li>
</WindowsWin_tcsh>

<Windows>
  <li>
    Only if you use the old Cygwin B-20 tools (new cygwin tools include 
    it already):   
    Perl 5 for Win32. You can download this binary from 
    <a href="http://www.activestate.com/Products/ActivePerl/Download.html">http://www.activestate.com/Products/ActivePerl/Download.html</a>. 
  </li>
</Windows>

<Windows>
  <li> 
    Cygwin Toolkit from 
    <a href="http://www.cygwin.com">http://www.cygwin.com</a>. 

    <br>
    Bison will also need a <CODE>C:\tmp</CODE> directory to function properly.
  </li>
</Windows>

<Win_tcsh>
  <li> 
    Cygwin Toolkit from 
    <a href="http://www.cygwin.com">http://www.cygwin.com</a>.
    The official informations on using the setup.exe and installing Cygwin are available at:
    <a href="http://cygwin.com/cygwin-ug-net/setup-net.html">http://cygwin.com/cygwin-ug-net/setup-net.html</a>. 
    More help and information on the Cygwin tools can be found at 
    <a href="http://website.openoffice.org/support/en/howtos/1.html">http://website.openoffice.org/support/en/howtos/1.html</a>.
   <p>
    When installing Cygwin make sure you set the "Default Text File Type" to
    "Unix". This is the default setting.
   <p>
    Not all Cygwin packages are needed to build OpenOffice.org, but make sure
    that the following packages are installed.
    <ul>
     bison<br>
     gawk<br>
     gzip<br>
     patch<br>
     tar<br>
     perl<br>
     zip
    </ul>
  </li>
</Win_tcsh>

<WindowsWin_tcsh>
  <li>
    A Microsoft Assembly compiler. This may already be present in your 
    installation in the same directory where the compiler is located (look for 

    Place <CODE>ML.EXE</CODE> and <CODE>ML.ERR</CODE> somewhere in a directory 
    and note the path, i.e. <CODE>C:\ml</CODE>
  </li>
</WindowsWin_tcsh>

<Windows>
  <li> <CODE>zip.exe</CODE> Version 2.2 or higher, and <CODE>unzip.exe</CODE>. 
    If you do not have these already, you can download them from 
    <a href="http://www.info-zip.org">www.info-zip.org</a>. 

    You have to use the native w32 version. 
    Make sure that the first zip.exe in your path is the native w32
    version, e.g. rename or delete the zip.exe in your cygwin /bin directory and
    copy the InfoZip version to this place.
    once the 4NT shell is no longer a requirement for the build environment.
  </li>
</Windows>

<WindowsWin_tcsh>
  <li>
    Parts of the Microsoft Platfrom SDK, namely: the MDAC SDK (May 2002 or 
    later), the 

  </li>

</ul>
</WindowsWin_tcsh>

<br>
<p>

</ul>
</Solaris>

<WindowsWin_tcsh>
<b>Hardware Requirements</b>

<ul>

  </li>

</ul>
</WindowsWin_tcsh> 
<p><br><p><br><p>




<li>
Another possibility is to check out the code from the cvs tree. 
<WindowsWin_tcsh>You may need <a href="www.socks.permeo.com">runsocks</a> to run 
cvs (with the new cygwin tools it is not 
necessary)</WindowsWin_tcsh>. If you 
don't have a username and password, you can still do a checkout as <CODE>anoncvs</CODE>: 
<pre>
<KBD>> cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs login</KBD>

Environment and Build Tools
</H2>

<LinuxSolarisWin_tcsh>
<p>
You use the <CODE>configure</CODE> script to generate the build environment.
The <CODE>configure</CODE> script checks that all software, hardware, and 
system requirements for the build are satisfied, and it creates a 
configuration file called </LinuxSolarisWin_tcsh><Linux>
<CODE>LinuxIntelEnv.Set</CODE></Linux><Solaris>
<CODE>SolarisSparcEnv.Set</CODE></Solaris><Win_tcsh>
<CODE>winenv.set</CODE></Win_tcsh><LinuxSolarisWin_tcsh>
that you then run the <CODE>source</CODE> command on to set all necessary 
build environment variables.
</LinuxSolarisWin_tcsh>
<Windows>
<p>
Ideally, in keeping with the principles of open source, you would use an open 
source shell to build on a computer running a Win32 operating system.  
However, this is still experimental (you chose the save way). You 
decided to use a non-open source shell to build on a computer running a Win32 
operating system: the 4NT command shell. </p>
<p>
On the other hand, the Cygnus <CODE>bash</CODE> shell is needed to run 


<p> 
This configuration file will be moved into the <CODE>SRC_ROOT</CODE> directory. 
A top-level makefile script <CODE>makefile.mk</CODE> <LinuxSolarisWin_tcsh> and the 
script <CODE>bootstrap</CODE> in the <CODE>config-office</CODE> directory </LinuxSolarisWin_tcsh> 
will be moved into <CODE>SRC_ROOT</CODE> as well. This is due to technical reasons: 
The <CODE>SRC_ROOT</CODE> directory in the cvs tree can only hold directories. 
On the other hand, the top-level <CODE>makefile.mk</CODE> should logically be 

CC and CXX point to your c and c++ compiler:
</p>

<p></LinuxSolaris>
<Linux>
<pre>
<KBD>CC=/your/path/to/gcc</KBD>

<KBD>CC=/your/path/to/cc</KBD>
<KBD>CXX=/your/path/to/CC</KBD>
</pre>
</Solaris><LinuxSolaris>
</p>

To run the <CODE>configure</CODE> script, type the following command:

<pre>
<KBD>$SRC_ROOT> cd config_office</KBD>
<KBD>config_office> ./configure</KBD>
</pre></LinuxSolaris>

<Win_tcsh>
<p>
Before running configure, make sure that all needed Programs are in the system path
or start configure the apropriate command line switches.
<p>
The following should demonstrate in detail what steps have to be done to 
set up the environment. For this examples we assume that
  <p>
  <ul>
    <li>
      the source code is in <CODE>C:\oo643B</CODE>
    </li>
    <li>
      JDK 1.3.1 is installed in <CODE>C:\jdk1.3.1</CODE>
    </li>
    <li>
      the Microsoft Compiler is located in 
      <CODE>C:\PROGRA~1\MICROS~3\VC98</CODE>
      (or <CODE>C:\program files\microsoft visual studio\vc98</CODE>)
    </li>
    <li>
      the Microsoft SDK is located in <CODE>C:\PROGRA~1\MICROS~5</CODE> 
      (only applies for 643B and later)
    </li>
    <li>
      and the assembly compiler resides in <CODE>C:\ml</CODE>
    </li>
  </ul>

<ul>
<H3>tcsh - Example</H3>
<b>As the use of the tcsh shell is still experimental, you have to enable it
with <CODE>--with-use-shell=tcsh</CODE></b>

<p>
To run the <CODE>configure</CODE> script, type the following command:

<p>
<pre>
<KBD>$SRC_ROOT> cd config_office</KBD>
<KBD>config_office> ./configure --with-cl-home=/cygdrive/c/PROGRA~1/MICROS~3/VC98 --with-asm-home=/cygdrive/c/ml --with-jdk-home=/cygdrive/c/jdk1.3.1 --with-use-shell=tcsh</KBD>
</pre>
</ul>
</Win_tcsh>

</LinuxSolarisWin_tcsh><p>
There are a number of options that you can use with the
<CODE>configure</CODE>
script. To display these options, type the following command:

<pre>
<KBD>config_office> ./configure --help</KBD>
</pre>
</LinuxSolarisWin_tcsh>

<Windows>
<p>

      the source code is in <CODE>C:\oo643B</CODE>
    </li>
    <li>
      your STLport files are stored in <CODE>C:\STLport-4.0</CODE>  
      (only in case you use your own STLport installation. If you 
      don't have this, or just don't care, the version provided in
      the source code will be build)
    </li>
    <li>
      JDK 1.3.1 is installed in <CODE>C:\jdk1.3.1</CODE>
    </li>
    <li>

  <CODE>
  (open a cygwin bash shell)
  <br>
  <b>cd /cygdrive/c/oo643B/config_office</b> (new cygwin tools) or <br>
  <b>cd //c/oo643B/config_office</b> (old cygwin b20 tools, deprecated)
  <br>
  <b>./configure --with-cl-home=/cygdrive/c/PROGRA~1/MICROS~3/VC98 --with-asm-home=/cygdrive/c/ml --with-jdk-home=/cygdrive/c/jdk1.3.1 --with-unzip-home=/cygdrive/c/unzip</b>
  <br>
  .
  <br>

  <br>
  (some screen output here)
  <br>
  Please enter the Java home directory: <b>/cygdrive/c/jdk1.3.1</b>
  <br>
  Please enter the MS-DOS format path for the Microsoft C/C++ compiler home 
  directory: <b>/cygdrive/c/PROGRA~1/MICROS~3/VC98</b>
  <br>
  Please enter the MS-DOS format path where the ml.exe assembler is located: 
  <b>/cygdrive/c/ml</b>
  <br>
  Please enter the MS-DOS format path where unzip.exe is located: 
  <b>/cygdrive/c/unzip</b>
  <br>
  .
  <br>
  .

</Windows>


<LinuxSolarisWin_tcsh>
<p> 
After running <CODE>configure</CODE>, you have to source the configuration 
file which sets all environment variables: 

</LinuxSolaris>
<Linux><KBD>$SRC_ROOT> source LinuxIntelEnv.Set</KBD></Linux>
<Solaris><KBD>$SRC_ROOT> source SolarisSparcEnv.Set</KBD></Solaris>
<Win_tcsh><KBD>$SRC_ROOT> source winenv.set</KBD></Win_tcsh><LinuxSolarisWin_tcsh>
</pre>
</LinuxSolarisWin_tcsh>
<Windows>

<p>

If you experiment with newest sources from the cvs-tree, mind that updates 
to the configure process do not happen via updates of <CODE>configure</CODE> 
(the script file) but via the files <CODE>configure.in</CODE> and 
<CODE>set_soenv.in</CODE>. The configure script itself is created from 
<CODE>configure.in</CODE> and <CODE>set_soenv.in</CODE> using the 
<CODE>autoconf</CODE> command. In this case, you would run commands 
like the following: <LinuxSolarisWin_tcsh> 
<pre>
<KBD>$SRC_ROOT> CD config_office</KBD>
<KBD>config_office> cvs update configure.in</KBD>
<KBD>config_office> autoconf</KBD>
</pre>
</LinuxSolarisWin_tcsh>
<Windows>
<pre>
<KBD>$SRC_ROOT> CD config_office</KBD>

to update the <CODE>configure</CODE> script. If you only use code from the 
snapshot releases on the web, you don't need to be concerned about this.

<LinuxSolarisWin_tcsh>
<p>
To create the build tools, type the following command:


<p>
The <CODE>bootstrap</CODE> utility creates the tools required for building.
This involves already building some modules and will take a few minutes.
</LinuxSolarisWin_tcsh>

<br><p><br><p><br><p>


You have to download the <CODE>solver</CODE> tree as a tarball 
<Linux><CODE>solver643B_linux_intel.tar.gz</CODE></Linux> 
<Solaris><CODE>solver643B_solaris_sparc.tar.gz</CODE></Solaris> 
<Win_tcsh><CODE>solver643B_win32int.tar.gz</CODE></Win_tcsh> 
<Windows><CODE>solver643B_win32int.tar.gz</CODE></Windows> 
from the Download page at 
<a href="http://www.openoffice.org/dev_docs/source/download.html">http://www.openoffice.org/dev_docs/source/download.html</a> 

<KBD>$SRC_ROOT> gunzip solver643B_solaris_sparc.tar.gz</KBD>
<KBD>$SRC_ROOT> tar -xvf solver643B_solaris_sparc.tar</KBD>
</Solaris>
<WindowsWin_tcsh>
<KBD>$SRC_ROOT> tar -xvzf solver643B_win32int.tar.gz</KBD>
</WindowsWin_tcsh>
</Windows>
</pre>

<LinuxSolarisWin_tcsh>
In order to create the build environment and build tools (bootstrap), you 
also have to check out the modules <CODE>config_office, dmake, external, 
xml2cmp, mkdepend, sal, solenv, vos, tools and rscpp</CODE>.
</LinuxSolarisWin_tcsh>
<Windows>
In order to create the build environment and build tools, you also have to 
check out the <CODE>config_office</CODE> module and <CODE>solenv</CODE>.

files by removing the 
<Linux><CODE>unxlngi3.pro</CODE></Linux>
<Solaris><CODE>unxsols3.pro</CODE></Solaris>
<WindowsWin_tcsh><CODE>wntmsci7.pro</CODE></WindowsWin_tcsh> 
directory. Then run <CODE>build</CODE> with the debug option set to true:

<pre>

If you have build an installation set earlier and want to re-build it, 
please delete the local outpath first: 
<pre>
<KBD>$SRC_ROOT/instsetoo> rm -rf <Linux>unxlngi3.pro</Linux><Solaris>unxsols3.pro</Solaris><WindowsWin_tcsh>wntmsci7.pro</WindowsWin_tcsh></KBD>
</pre>

<p>
The English installation set will be located at 
<CODE>$SRC_ROOT/instsetoo/<Linux>unxlngi3.pro</Linux><Solaris>unxsols3.pro</Solaris><WindowsWin_tcsh>wntmsci7.pro</WindowsWin_tcsh>/01/normal</CODE>. 
Execute the <CODE>setup</CODE> binary to install:
<pre>
<KBD>$SRC_ROOT> CD instsetoo/<Linux>unxlngi3.pro</Linux><Solaris>unxsols3.pro</Solaris><WindowsWin_tcsh>wntmsci7.pro</WindowsWin_tcsh>/01/normal</KBD>
<KBD><LinuxSolaris>normal> ./setup</LinuxSolaris><WindowsWin_tcsh>normal> setup.exe</WindowsWin_tcsh></KBD>
</pre>

The 01 in the path names indicates that the localisation is american english. This number 

to be unzipped into the directory 

<pre>
<Linux><CODE>$SRC_ROOT/solver/641/unxlngi4.pro/pck</CODE>.</Linux><Solaris><CODE>$SRC_ROOT/solver/641/unxsols3.pro/pck</CODE>.</Solaris><WindowsWin_tcsh><CODE>$SRC_ROOT/solver/641/wntmsci7.pro/pck</CODE>.</WindowsWin_tcsh>
</pre>

The filenames of these files contain a number code for the language, corresponding to 
the international phone code of a country in which that language is mainly spoken. 
For instance, the file <CODE>
<LinuxSolaris>helpcontent_34_unix.tgz</LinuxSolaris><WindowsWin_tcsh>helpcontent_34_wnt.zip</WindowsWin_tcsh>
</CODE> contains all helpcontent for the spanish localisation. 
The zipfiles themselves are available at 
<a href="http://ftp.services.openoffice.org/pub/OpenOffice.org/contrib/helpcontent/">ftp.services.openoffice.org/pub/OpenOffice.org/contrib/helpcontent/</a>.

chapter. English installation sets will be located in 

<pre>
<CODE>$SRC_ROOT/instsetoo/<Linux>unxlngi3.pro</Linux><Solaris>unxsols3.pro</Solaris><WindowsWin_tcsh>wntmsci7.pro</WindowsWin_tcsh>/01/normal</CODE>, 
</pre>

where 01 corresponds to the international phone code of the USA. 

you will find an additional directory called 33:  

<pre>
<CODE>$SRC_ROOT/instsetoo/<Linux>unxlngi3.pro</Linux><Solaris>unxsols3.pro</Solaris><WindowsWin_tcsh>wntmsci7.pro</WindowsWin_tcsh>/33/normal</CODE>.
</pre>

Similarily, you will find 49 for German, 34 for Spanish, etc. </p>

Return to issue 13097