Index: build_template.html =================================================================== RCS file: /cvs/www/www/styles/build_template.html,v retrieving revision 1.36 diff -u -r1.36 build_template.html --- build_template.html 10 Mar 2003 16:59:45 -0000 1.36 +++ build_template.html 6 Apr 2003 18:45:45 -0000 @@ -5,19 +5,22 @@

-Building OpenOffice.org under LinuxSolarisWindows +Building OpenOffice.org under LinuxSolarisWindows with tcshWindows with 4NT

- +

+The Cygwin tcsh environment is experimental, and can be used starting with +cws_srx644_ooo20030412. +

This document describes the requirements and actions that you need to build -OpenOffice.org on Linux.Solaris.Windows. +OpenOffice.org on Linux.Solaris.Windows using Cygwin shellWindows.

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

 config_office> ./configure
@@ -26,7 +29,7 @@
 

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

@@ -47,8 +50,9 @@

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 643B). Links to the different -sources are given in the document. +a less stable developer branch (latest release see +here). +Links to the different sources are given in the document.




@@ -167,22 +171,22 @@

  • Get the source code, either from the download webpage (www.openoffice.org/dev_docs/source/download.html) or alternatively via a check-out from the cvs tree against a release tag, - e.g. OpenOffice643.
  • - + e.g. cws_srx644_ooo11beta. +
  • Run the configure script to check all requirements and to - create the script - LinuxIntelEnv.Set.SolarisSparcEnv.Set. + create the script + LinuxIntelEnv.Set.SolarisSparcEnv.Set.winenv.set.
  • Run the configure script in a cygwin bash shell to check all requirements and to create the script winenv.bat.
  • Run the - LinuxIntelEnv.SetSolarisSparcEnv.Setwinenv.bat (under 4NT) script to set all environment variables. + LinuxIntelEnv.SetSolarisSparcEnv.Setwinenv.setwinenv.bat (under 4NT) script to set all environment variables.
  • - +
  • Create the build tools using bootstrap.
  • -
    +
  • Build typing dmake in $SRC_ROOT, or build -all in the instsetoo module, or build followed by deliver in the individual @@ -215,6 +219,7 @@ solver643B_linux_intel.tar.gz. solver643B_solaris_sparc.tar.gz. solver643B_win32intel.tar.gz. + solver643B_win32intel.tar.gz.
  • Check out the modules for the project that you want to build from the @@ -226,21 +231,22 @@ However, it is not possible to download individual modules there.
  • Check out the module config_office. This is always necessary to create the build environment.
  • - +
  • Also check out the modules dmake, external, xml2cmp, mkdepend, sal, solenv, vos, tools and rscpp. These are required by bootstrap (see below).
  • -
    +
  • Also check out the module solenv.
  • Unpack the solver tarball in the $SRC_ROOT directory.
  • - +
  • Run the configure script to check all requirements and to create the script - + LinuxIntelEnv.Set. SolarisSparcEnv.Set. + winenv.set.
  • Run the configure script in a cygwin bash shell to check all requirements and to create the script winenv.bat. @@ -249,12 +255,13 @@
  • Run the script LinuxIntelEnv.Set SolarisSparcEnv.Set + winenv.set winenv.bat to set all environment variables.
  • - +
  • Create the build tools using bootstrap.
  • -
    +
  • Build each module against the prebuild solver using the build tool, followed by deliver.
  • @@ -274,7 +281,7 @@ 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, Solaris, -Windows, these are as follows: +Windows, Windows, these are as follows:

    @@ -365,7 +372,7 @@ - +

    Build Requirements

      @@ -376,7 +383,9 @@
    • Microsoft Visual C++ Version 6 Service Pack 3.
    • + +
    • 4NT Version 2.5 or higher. You can download this from ftp://jpsoft.com/4nt/. @@ -393,18 +402,24 @@ LocalAliases = Yes
    + +
  • JDK 1.3.1.
  • +
    +
  • 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 http://www.activestate.com/Products/ActivePerl/Download.html.
  • +
    +
  • Cygwin Toolkit from http://www.cygwin.com. @@ -445,7 +460,35 @@
    Bison will also need a C:\tmp directory to function properly.
  • +
    + + +
  • + Cygwin Toolkit from + http://www.cygwin.com. + The official informations on using the setup.exe and installing Cygwin are available at: + http://cygwin.com/cygwin-ug-net/setup-net.html. + More help and information on the Cygwin tools can be found at + http://website.openoffice.org/support/en/howtos/1.html. +

    + When installing Cygwin make sure you set the "Default Text File Type" to + "Unix". This is the default setting. +

    + Not all Cygwin packages are needed to build OpenOffice.org, but make sure + that the following packages are installed. +

    +
  • +
    +
  • A Microsoft Assembly compiler. This may already be present in your installation in the same directory where the compiler is located (look for @@ -455,7 +498,9 @@ Place ML.EXE and ML.ERR somewhere in a directory and note the path, i.e. C:\ml
  • +
    +
  • zip.exe Version 2.2 or higher, and unzip.exe. If you do not have these already, you can download them from www.info-zip.org. @@ -463,10 +508,11 @@ 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. This issue should become obsolete - once the 4NT shell is no longer a requirement for the build environment. + copy the InfoZip version to this place.
  • +
    +
  • Parts of the Microsoft Platfrom SDK, namely: the MDAC SDK (May 2002 or later), the @@ -503,7 +549,7 @@
  • - +

    @@ -549,7 +595,7 @@ - + Hardware Requirements

    - +



    @@ -611,9 +657,9 @@

  • Another possibility is to check out the code from the cvs tree. -You may need runsocks to run -cvs (with the cygwin tools it is not -necessary). If you +You may need runsocks to run +cvs (with the new cygwin tools it is not +necessary). If you don't have a username and password, you can still do a checkout as anoncvs:
     > cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs login
    @@ -676,23 +722,24 @@
     Environment and Build Tools
     
     
    -
    +
     

    You use the configure script to generate the build environment. The configure script checks that all software, hardware, and system requirements for the build are satisfied, and it creates a -configuration file called +configuration file called LinuxIntelEnv.Set -SolarisSparcEnv.Set +SolarisSparcEnv.Set +winenv.set that you then run the source command on to set all necessary build environment variables. - +

    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 not possible at present (though we're working on it!). You -must use a non-open source shell to build on a computer running a Win32 +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.

    On the other hand, the Cygnus bash shell is needed to run @@ -705,8 +752,8 @@

    This configuration file will be moved into the SRC_ROOT directory. -A top-level makefile script makefile.mk and the -script bootstrap in the config-office directory +A top-level makefile script makefile.mk and the +script bootstrap in the config-office directory will be moved into SRC_ROOT as well. This is due to technical reasons: The SRC_ROOT directory in the cvs tree can only hold directories. On the other hand, the top-level makefile.mk should logically be @@ -720,7 +767,7 @@ CC and CXX point to your c and c++ compiler:

    -

    +

     CC=/your/path/to/gcc
    @@ -732,7 +779,7 @@
     CC=/your/path/to/cc
     CXX=/your/path/to/CC
     
    - +

    To run the configure script, type the following command: @@ -741,9 +788,54 @@
     $SRC_ROOT> cd config_office
     config_office> ./configure
    -
    +
    +

    +Before running configure, make sure that all needed Programs are in the system path +or start configure the apropriate command line switches. +

    +The following should demonstrate in detail what steps have to be done to +set up the environment. For this examples we assume that +

    +

    + + +
    + +

    There are a number of options that you can use with the configure script. To display these options, type the following command: @@ -752,7 +844,7 @@

     config_office> ./configure --help
     
    - +

    @@ -772,12 +864,6 @@ the source code is in C:\oo643B

  • - your STLport files are stored in C:\STLport-4.0 - (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) -
  • -
  • JDK 1.3.1 is installed in C:\jdk1.3.1
  • @@ -806,10 +892,10 @@ (open a cygwin bash shell)
    - cd //c/oo643B/config_office (old cygwin b-20 tools) or
    - /cygdrive/c/oo643B/config_office (new cygwin tools - we stay -with that notation for the rest of this example)
    - bash configure --with-stlport4-home=/cygdrive/c/STLport-4.0 + cd /cygdrive/c/oo643B/config_office (new cygwin tools) or
    + cd //c/oo643B/config_office (old cygwin b20 tools, deprecated) +
    + ./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
    .
    @@ -819,17 +905,6 @@
    (some screen output here)
    - Please enter the Java home directory: /cygdrive/c/jdk1.3.1 -
    - Please enter the MS-DOS format path for the Microsoft C/C++ compiler home - directory: /cygdrive/c/PROGRA~1/MICROS~3/VC98 -
    - Please enter the MS-DOS format path where the ml.exe assembler is located: - /cygdrive/c/ml -
    - Please enter the MS-DOS format path where unzip.exe is located: - /cygdrive/c/unzip -
    .
    . @@ -871,7 +946,7 @@ - +

    After running configure, you have to source the configuration file which sets all environment variables: @@ -881,9 +956,9 @@ $SRC_ROOT> source LinuxIntelEnv.Set $SRC_ROOT> source SolarisSparcEnv.Set - +$SRC_ROOT> source winenv.set - +

    @@ -897,16 +972,16 @@ If you experiment with newest sources from the cvs-tree, mind that updates to the configure process do not happen via updates of configure (the script file) but via the files configure.in and -set_soenv.1. The configure script itself is created from -configure.in and set_soenv.1 using the +set_soenv.in. The configure script itself is created from +configure.in and set_soenv.in using the autoconf command. In this case, you would run commands -like the following: +like the following:

     $SRC_ROOT> CD config_office
     config_office> cvs update configure.in
     config_office> autoconf
     
    -
    +
     $SRC_ROOT> CD config_office
    @@ -921,7 +996,7 @@
     to update the configure script. If you only use code from the 
     snapshot releases on the web, you don't need to be concerned about this.
     
    -
    +
     

    To create the build tools, type the following command: @@ -933,7 +1008,7 @@

    The bootstrap utility creates the tools required for building. This involves already building some modules and will take a few minutes. - +



    @@ -1092,6 +1167,7 @@ You have to download the solver tree as a tarball solver643B_linux_intel.tar.gz solver643B_solaris_sparc.tar.gz +solver643B_win32int.tar.gz solver643B_win32int.tar.gz from the Download page at http://www.openoffice.org/dev_docs/source/download.html @@ -1105,17 +1181,16 @@ $SRC_ROOT> gunzip solver643B_solaris_sparc.tar.gz $SRC_ROOT> tar -xvf solver643B_solaris_sparc.tar - -$SRC_ROOT> gunzip solver643B_win32int.tar.gz -$SRC_ROOT> tar -xvf solver643B_win32int.tar - + +$SRC_ROOT> tar -xvzf solver643B_win32int.tar.gz +

    - + In order to create the build environment and build tools (bootstrap), you also have to check out the modules config_office, dmake, external, xml2cmp, mkdepend, sal, solenv, vos, tools and rscpp. - + In order to create the build environment and build tools, you also have to check out the config_office module and solenv. @@ -1153,7 +1228,7 @@ files by removing the unxlngi3.pro unxsols3.pro -wntmsci7.pro +wntmsci7.pro directory. Then run build with the debug option set to true:
    @@ -1180,16 +1255,16 @@
     If you have build an installation set earlier and want to re-build it, 
     please delete the local outpath first: 
     
    -$SRC_ROOT/instsetoo> rm -rf unxlngi3.prounxsols3.prowntmsci7.pro
    +$SRC_ROOT/instsetoo> rm -rf unxlngi3.prounxsols3.prowntmsci7.pro
     

    The English installation set will be located at -$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal. +$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal. Execute the setup binary to install:

    -$SRC_ROOT> CD instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal
    -normal> ./setupnormal> setup.exe
    +$SRC_ROOT> CD instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal
    +normal> ./setupnormal> setup.exe
     
    The 01 in the path names indicates that the localisation is american english. This number @@ -1233,13 +1308,13 @@ to be unzipped into the directory
    -$SRC_ROOT/solver/641/unxlngi4.pro/pck.$SRC_ROOT/solver/641/unxsols3.pro/pck.$SRC_ROOT/solver/641/wntmsci7.pro/pck.
    +$SRC_ROOT/solver/641/unxlngi4.pro/pck.$SRC_ROOT/solver/641/unxsols3.pro/pck.$SRC_ROOT/solver/641/wntmsci7.pro/pck.
     
    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 -helpcontent_34_unix.tgzhelpcontent_34_wnt.zip +helpcontent_34_unix.tgzhelpcontent_34_wnt.zip contains all helpcontent for the spanish localisation. The zipfiles themselves are available at ftp.services.openoffice.org/pub/OpenOffice.org/contrib/helpcontent/. @@ -1251,7 +1326,7 @@ chapter. English installation sets will be located in
    -$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal, 
    +$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/01/normal, 
     
    where 01 corresponds to the international phone code of the USA. @@ -1259,7 +1334,7 @@ you will find an additional directory called 33:
    -$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/33/normal.
    +$SRC_ROOT/instsetoo/unxlngi3.prounxsols3.prowntmsci7.pro/33/normal.
     
    Similarily, you will find 49 for German, 34 for Spanish, etc.