                    KYLIX 3
               INSTALLATION NOTES

                    ********
                    WARNINGS
                    ********
If Kylix 1 or 2 is installed on your machine, you 
should back up the following configuration files BEFORE 
continuing with this installation. If you proceed 
without backing up these files, they will be 
overwritten with Kylix 3 configuration data.

   Directory       Files
   ---------       -----
   $HOME/bin       dcc
                   startkylix
               
   $HOME/.borland  .borlandrc

Also in the .borland directory, you should first
back up your two dbx* configuration files, then
DELETE the two files (these two are not automatically
overwritten with Kylix 3-specific data).

If installing as root and you have Kylix 1 or 2
installed, you should also back up the following global
configuration files:
       
/usr/local/etc/borlandrc.conf
/usr/local/etc/dcc.conf
/usr/local/etc/dbxconnections.conf
/usr/local/etc/dbxdrivers.conf

                   ********

Do not use a package manager, such as rpm,
kpackage, or gnorpm, to install or uninstall
Kylix. Always use the install and uninstall
programs provided by Borland.

NOTE: Do not attempt to install directly to a symbolic 
      link to a directory, as the uninstall scripts will give 
      an error that location is not a directory. For instance, 
      if /root/kylix is a symbolic link to /opt/kylix, and you 
      have installed directly to /root/kylix, the uninstall script 
      will fail. Instead, install to a subdirectory such as 
      /opt/kylix/kylix3 and create your symbolic link to /opt/kylix
      
========
CONTENTS
========

KYLIX REQUIREMENTS
ROOT VERSUS NON-ROOT INSTALL
THE KYLIX INSTALLER
INSTALLATION PROCEDURE
LIBRARY DEPENDENCIES
ISSUES WITH glibc
INSTALLING libjpeg 6.2
STANDARD C++ LIBRARY ISSUES
OBJECT REPOSITORY
KDE/SuSE ISSUE
PREVIEW BROWSER INSTALLATION ISSUE
VISIBROKER/JRE INSTALLATION ISSUES
ACTIVATION AND REGISTRATION
UNINSTALLING
ABOUT THE INSTALLER


==================
KYLIX REQUIREMENTS
==================

Many users will need to upgrade the glibc libraries before
installing Kylix. For information, see the PREINSTALL document.

In addition, you must install the following software before 
installing Kylix:

 - Linux kernel version 2.2 or higher
 - libgtk.so version 1.2 or higher
   (required for WebSnap previews and
    graphical installation)
 - libjpeg version 6.2 (libjpeg.so.62) or higher
 - an X11R6-compatible terminal server, such as XFree86.

For information about installing libjpeg version 6.2, see 
"Library dependencies" below.

Kylix must be installed on a file system that supports
symbolic links, such as Linux's ext2. Do not install Kylix on
FAT, FAT32, SMB (including Samba), or Novell file systems. NFS
file systems should work but have not been tested.

Kylix has been tested with various window managers and
desktops, including GNOME and KDE, but these programs are not
required in order for Kylix to install or run.

Enlightenment and older Red Hat distributions
---------------------------------------------

If you are running Kylix on Red Hat 6.2 or earlier and
you are running the Enlightment window manager, you may 
need to update Enlightenment.


============================
ROOT VERSUS NON-ROOT INSTALL
============================

Kylix can be installed by any user who has the necessary
disk space. If you do not have the password for the "root"
account on your machine, you will have to install Kylix using a
non-root account. If you have the root password, you need to
decide whether to install Kylix as root or as another user.

Here are the advantages of installing as root:

  - If the installer has full access to the system, it can
    automatically resolve some installation problems, such as
    missing library links.
  - All files are placed in standard, central locations, so that
    any user can run Kylix.
  - Users can share CLX objects, using the Kylix Object
    Repository. (However, you must set file permissions to allow
    for shared access. See "Object Repository," below.)
  - If your system uses the RPM Package Manager, the installer
    adds a set of Kylix entries to the RPM database. This allows
    dependencies between Kylix and other software to be
    maintained automatically.

Here are the advantages of installing as a non-root user:

  - You own all Kylix files, and do not have to take any
    additional steps to work with the demo projects, modify the
    Object Repository, and so on.
  - If you omit some install options and decide to add them
    later, the installer will automatically configure your
    .borland/delphi69rc file to make these options available.
    With a root install, the only way to update this file is to
    delete it, so that Kylix regenerates it. Unfortunately,
    deleting this file causes your IDE option changes to be
    lost.


===================
THE KYLIX INSTALLER
===================

Kylix installs equally well on RPM and non-RPM systems.
Although the Kylix installer can update the RPM package database,
the installer can also work independently of RPM.

If your system does have RPM, and if you install Kylix as the
root user, up to 12 Kylix packages are added to the installed
packages list. Uninstalling Kylix removes these packages. All
package names begin with "kylix3_". If your system does not have
RPM, or if you install Kylix as a user other than root, the
installer simply skips this step.

The installer allows you to select or deselect all install
options independently. However, only the Main Program Files
option and Help Files option are independent. If you deselect
Main Program Files and that option is not already installed,
selecting the other options causes an error.

NOTE: The default installation location for Kylix is beneath the 
      home directory of the installing user, or, in /usr/local/
      if installing as root.


======================
INSTALLATION PROCEDURE
======================

To install Kylix, follow these steps:

1. Log in as root (the super user; this step is optional if you 
   do not need Kylix to be accessible by all users).

2. If you are using X Windows, open a shell window.

3. Insert the CD-ROM in the drive, and mount the CD-ROM
   file system.

4. Change your working directory to the CD-ROM mount point.

5. Run the Kylix installer, setup.sh. If your CD-ROM file system
   is not configured to support executables, you must use
   the shell command
   
   sh setup.sh

6. Follow the installer prompts.

For example, on a system configured to mount the CD-ROM device at
/mnt/cdrom, the following shell commands mount the CD-ROM file
system and run the installer:

 mount /mnt/cdrom
 cd /mnt/cdrom
 sh setup.sh

Your system may use a mount point other than /mnt/cdrom.
Substitute that mount point in the example above.

NOTE: Do not enter a line break in a path specification
      (or use a symbolic link that contains a line break) when
      installing Kylix in text mode.

If run under X Windows and the correct version of libgtk.so is
available, the Kylix installer prompts you with an X Windows
dialog box. Otherwise, the Kylix installer prompts you with
a series of text console prompts. In either case, you are prompted
to specify an Install Path and a Link Path:

 - Install Path and its subdirectories contain all the
   files required to run Kylix. This directory is created
   if it does not already exist. Specify a location that is
   writable by you and readable by all users that will run
   Kylix.

 - Link Path contains symbolic links for the Kylix IDE,
   compiler, and Help viewer. This directory must already
   exist, be writable by you, and be readable by all users
   that will run Kylix. Link Path cannot be the same as
   Install Path.

Even if you install Kylix as root, you should always run Kylix
as an ordinary user. You can install Kylix as an ordinary user,
but in that case only the installing user will be able to run
Kylix. 

The Kylix versions of the Qt Libraries are installed within
the Kylix directory tree. These libraries do not affect any other
versions of Qt that you have installed.


====================
LIBRARY DEPENDENCIES
====================

Kylix has the following library dependencies:

 - Kylix requires glibc 2.1.2 or later, as do applications
   created with Kylix. Also, bugs in some versions of glibc can
   affect Kylix and Kylix applications. See "Issues with glibc"
   below.

 - Kylix requires libjpeg 6.2 or later. The Kylix installation
   CD-ROM includes an RPM package for this library. See
   "Installing libjpeg 6.2" below.

 - Kylix requires that certain naming dependency problems in the
   standard C++ library be resolved. The problem is not always
   present and is usually resolved automatically by the Kylix
   installer. In some circumstances, you may have to resolve the
   problem manually. See "Standard C++ Library Issues" below.

 - If you install the dbExpress InterBase client driver, you 
   need to have libcrypt.so installed. Some Linux distributions
   omit this library or do not include it in a base install. When
   installing, be sure to include glibc-devel in the package list. 
   If your distribution does not include libcrypt.so, contact the 
   package maintainer, or search online Linux resources, such as 
   http://rpmfind.net/.

 - libgtk 1.2 is required for graphical installation and for the
   Mozilla preview widget (for previewing WebSnap pages).

 - Some Linux distributions provide all the libraries required to
   run Kylix, but do not use the naming conventions that Kylix
   expects. The most common problem is library names with
   embedded version information, while Kylix expects
   version-independent names. If Kylix software fails to run
   because of missing shared libraries, check for similarly named
   libraries in /lib and /usr/lib. You can then create a symbolic
   link to help Kylix find the library. For example, if you are
   missing libcrypt.so but find /lib/libcrypt.so.1, you would
   enter the following shell commands as root:

    cd /lib
    ln -s libcrypt.so.1 libcrypt.so


=================
ISSUES WITH glibc
=================

The Kylix installer will abort if it does not detect glibc
2.1.2 or later. Specific procedures for upgrading this library
vary by Linux distribution. See PREINSTALL for more information.

Some glibc problems may not become apparent until after Kylix is
installed. If you suspect glibc problems, check the version. On
an RPM-enabled distribution, you can determine the current
version of glibc with the following shell command:

  rpm -qa | grep glibc

Also, running a Kylix install creates a file called
borland_kylix_install_log in the home directory of the 
installing user. Refer to the field "libc version" in that file.

With glibc 2.1.3, make sure that your LANG and LC_ALL
environment variables are set to a value other than C or
POSIX. For a list of available locales, use the locale shell
command:

  locale -a

The "en" locales are used in English-speaking countries.

Inconsistencies in some versions of glibc may affect AnsiCompareStr 
and other ANSI-enabled functions. For details on these issues, see
the README document.


======================
INSTALLING libjpeg 6.2
======================

Kylix requires libjpeg version 6.2 or higher (libjpeg.so.62),
An RPM package for this library is provided on the
installation CD-ROM. If you are logged in as root and
have the CD-ROM mounted on /mnt/cdrom, the following shell
command sequence installs the library:

  rpm -U /mnt/cdrom/patches/jpeg-6.2.0/libjpeg-6.2.0
  cd /usr/lib
  ln -sf libjpeg.so.62.0.0 libjpeg.so.6


===========================
STANDARD C++ LIBRARY ISSUES
===========================

On some systems, naming conflicts between different versions
of the standard C++ library must be resolved before Kylix can
run. This problem is known to occur on Debian Linux 2.2, and
the installer will automatically create the necessary
symbolic link if this distribution is detected. 

The installer might not detect the conflict if the C++
libraries have been upgraded manually, or if Kylix is
installed on other distributions based on Debian. In this 
case, you must create the symbolic link manually.

Kylix basically needs to have a file in /usr/lib or /lib named
libstdc++-libc6.1-1.so.2. This file should be a symbolic link
to the C++ library, which will also be in /usr/lib or /lib and
have a name that fits the pattern libstdc++*.so. So, for
example, if you look in /usr/lib and find a file called
libstdc++-3-libc6.1-2-2.10.so, you would enter the following
shell commands to create the symbolic link:

  cd /usr/lib
  ln -sf libstdc++-3-libc6.1-2-2.10.so libstdc++-libc6.1-1.so.2


=================
OBJECT REPOSITORY
=================

If you want multiple users to access a common Object Repository,
you should create a developers' group and give its members
read-write access to the objrepos directory. For example, if you
named the group "dev" and had previously installed Kylix in
/usr/local/kylix, you would set the permissions by entering

  cd /usr/local/cortez
  chmod -R 775 objrepos
  chgrp -R dev objrepos

See the group(5) man page for more information.


==============
KDE/SuSE ISSUE
==============

Installing Kylix on SuSE in KDE falls back to text mode
-------------------------------------------------------

If you start KDE as one user and "su" to become another user, 
then attempt a Kylix GUI installation, the text mode installation will
start instead. Reason: The X Server is looking for a magic cookie value 
in the ~/.Xauthority file of the "su" user, but the value it is looking
for is actually in the ~/.Xauthority file of the user who started KDE.

Solution: Exit KDE, log out from the console, and log in again as the
user you wish to perform the GUI installation. Then start KDE and 
begin the installation.


=====================
VISIBROKER/JRE ISSUES
=====================

VisiBroker installation notes
-----------------------------
[Enterprise and Trial editions only]

IMPORTANT: VisiBroker is not certified for use with Red Hat 6.2. 
           For VisiBroker platform support information, see
http://www.borland.com/techpubs/visibroker/platforms/vbcpp45.html#vbcpp-red-hat-linux

VisiBroker requires the installation of the Java Runtime
Environment (see below), and the inclusion of VisiBroker PATH environment
variables. 

To install VisiBroker as part of your Kylix Enterprise installation, 
simply choose the VisiBroker option during your Kylix install.

To install VisiBroker from a Trial Editon CD: 
Execute the setup script in the /visibroker directory on your CD, 
and follow the instructions.

Licensing note (Trial Edition only): 
In the License Key Validation window, fill in the User name and 
Company name fields and leave the License key field empty to enable 
your 60-day trial.

VisiBroker is installed under your Kylix main directory, in a 
subdirectory called /vbroker. Before running your CORBA applications, 
you need to set the OSAgent port and LD_LIBRARY_PATH environment 
variables for VisiBroker. You can do this in either of two ways:

-- Source the VisiBroker script file (vbroker.sh) in your 
   /vbroker directory (recommended for CORBA console applications):
   
   source ./kylix3/vbroker/vbroker.sh
   
   or
   
-- Source kylixpath (for CORBA GUI apps) to set all of the
   required VisiBroker and Kylix environment variables:
   
   source ./kylix3/bin/kylixpath

Then start osagent and run it as a background task with this command: 

    osagent &


JRE installation note
---------------------

You must install the Java Runtime Environment 1.3.1_01 
manually, as follows. 

As root:

1. Copy j2re-1_3_1_01-linux-i386-rpm.bin from
   your CD to local directory.

   cp <path/to/file/on/CD>j2re-1_3_1_01-linux-i386-rpm.bin /tmp

2. If the file is not executable, change the permissions to allow it
   to execute.

   chmod +x /tmp/j2re-1_3_1_01-linux-i386-rpm.bin

3. Run the file

   /tmp/j2re-1_3_1_01-linux-i386-rpm.bin

4. Once you have accepted the license agreement, 
   install the extracted rpm file.

   rpm -Uvh /tmp/jre-1.3.1_01.i386.rpm
   
5. Make sure the jre bin directory is included in your path. Add
   /usr/java/jre1.3.1_01/bin to the PATH section of the .bash_profile
   file in your home directory. You will need to log out and log
   back in before this takes effect.


===========================
ACTIVATION AND REGISTRATION 
===========================

To activate this product, you must obtain a Serial Number 
and Authorization Key or an activation file. 

The Serial Number and Authorization Key for Open and Trial editions 
are contained in a Software License activation file that you must 
obtain from the Borland Web site:

  http://reg.borland.com/
  
The Software License for Open and Trial products will be emailed to 
you upon submission of the form on that site. If you are using the 
Trial Edition to evaluate the product, your evaluation period begins 
on the day you submit your request for an authorization key.

If you purchased a Kylix CD (or are installing the Open Edition
from CD), the Serial Number and Authorization Key is supplied with
your CD.

After activation, you must also register the product. 

The Registration dialog, which appears on first use 
after activation, offers three registration methods: 
Online (direct registration through a secure connection), 
by telephone, or through a Web form.

Each of the Registration options is driven by wizards, 
with Help provided where necessary.

NOTE: Online activation and registration requires an active 
      Internet connection. The process uses port 443 for the 
      transaction;  if there is a problem using that port, an 
      attempt is made through port 8080. If your machine is 
      protected by a firewall and the process fails, you must 
      either contact your system administrator to request that 
      the ports noted above be made available, or use an 
      alternate registration method, such as telephone or Web 
      registration. Online registration also requires that all 
      users of this copy of the software use the same software 
      registration account when registering.

REGISTRATION DEFERRAL

All versions require registration.  Registration for the Professional and
Enterprise versions may be deferred.  The Open and Trial versions will NOT
run without a valid Software License.  The software license contains the
registration information.

If you try to run either the Open or Trial versions without a valid Software
License, you will be directed where to go to obtain one.


If you choose to defer registration, you can register later by following 
these steps:

1.  Open a terminal window and type 

    <Kylix directory>/bin/registerkylix
    
    This starts the Kylix Registration Software utility. The 
    utility may also be available as a menu item in your Kylix
    program group.  
        
   
============
UNINSTALLING
============

To uninstall Kylix, execute the uninstall program in your Kylix 
installation directory. You must execute this program as the same 
user who ran the installation. Uninstalling removes files that 
were copied to your hard drive during installation, but does not 
restore previously existing configuration files that were 
modified by the installer.

NOTE: You must uninstall as the same user which installed Kylix. 

      

===================
ABOUT THE INSTALLER
===================

The installer for this product is based on the open-source Setup
project from Loki Games. In accordance with the LGPL, the sources
for this branch of the project are available from Borland's
Developer Support web site at http://www.borland.com/devsupport/.
This is a dead branch of the Setup project and will not be
maintained or supported by Borland or Loki Games.


-------------------------------------------------------
Copyright (c) 2002 Borland Software Corporation. 
All rights reserved.
-------------------------------------------------------

