Appendix A: Installation

This appendix explains how to install BitKeeper, including:

• Installing the Software
• Getting a License After Completing these steps you will be able to run BitKeeper.

Installing The Software

This section describes how to install BitKeeper. There are four steps to installing and verifying the BitKeeper installation:

• Figuring out which software to download
• Downloading the software
• Installing it on the machine
• Running regression tests

Once the four steps are accomplished, BitKeeper will be ready for use.

Supported Platforms

The download area contains a a number of images for different platforms. If you are wondering which one is the right image for your platform, the table below may help. The release number portion of the image name may be different as we release new releases but the architecture portion should always be the same.

Platform name	Download image name
AIX 4.1.5 and later	bk-3.2.4-powerpc-aix.bin
FreeBSD 2.x	bk-3.2.4-x86-freebsd2.bin
FreeBSD 3.x	bk-3.2.4-x86-freebsd3.bin
FreeBSD 4.x	bk-3.2.4-x86-freebsd4.bin
FreeBSD 5.x	bk-3.2.4-x86-freebsd5.bin
HPUX 10.20	bk-3.2.4-hppa-hpux10.bin
HPUX 11.x	bk-3.2.4-hppa-hpux11.bin
IRIX 6.5 and later	bk-3.2.4-mips-irix.bin
Linux/Alpha	bk-3.2.4-alpha-glibc22-linux.bin
Linux/Itanium	bk-3.2.4-ia64-glibc23-linux.bin
Linux/MIPS	bk-3.2.4-mips-glibc22-linux.bin
Linux/PARISC	bk-3.2.4-hppa-glibc23-linux.bin
Linux/PPC	bk-3.2.4-powerpc-glibc23-linux.bin
Linux/SPARC	bk-3.2.4-sparc-glibc23-linux.bin
Linux/StrongARM	bk-3.2.4-arm-glibc21-linux.bin
Linux/x86 (Glibc 2.0)	bk-3.2.4-x86-glibc20-linux.bin
Linux/x86 (Glibc 2.1)	bk-3.2.4-x86-glibc21-linux.bin
Linux/x86 (Glibc 2.2)	bk-3.2.4-x86-glibc22-linux.bin
Linux/x86 (Glibc 2.3)	bk-3.2.4-x86-glibc23-linux.bin
MacOS X	bk-3.2.4a-powerpc-macosx.bin
NetBSD/x86	bk-3.2.4-x86-netbsd.bin
OpenBSD/x86	bk-3.2.4-x86-openbsd.bin
Solaris/SPARC	bk-3.2.4-sparc-solaris.bin
Solaris/x86	bk-3.2.4-x86-solaris.bin
Windows (all releases)	bk-3.2.4-x86-win32.exe

Downloading Software

Go to www.bitkeeper.com, click on downloads in the left column, and then click on "Go here to download BitKeeper".

You will be asked for your name and email address. Once you submit your request for downloading instructions an email will be sent to the address you entered. Follow the download instructions sent, noting the login and password.

Read the license.

At the end of the license there are directories of BitKeeper releases. Click on the directory of the latest version of BitKeeper. There will be a list of BitKeeper binaries. The binary names are in the form

cpu_type-OperatingSystem.file_type

Click on the one that corresponds to the system upon which BitKeeper will be installed. Specify the destination directory and file name and click the "okay" button.

Installing on Unix

Once downloaded, change the permissions and execute the binary. For example, if the x86-glibc21-linux.bin binary was downloaded,

chmod +x x86-glibc21-linux.bin ./x86-glibc21-linux.bin

Enter the directory to install, /usr/libexec is recommended, and hit return.

At this point BitKeeper should be installed and the BitKeeper regression tests should be run to verify the installation. Please see the Trouble Shooting section or contact support@bitmover.com if there are problems regarding the installation.

Installing on Windows

Once downloaded, double-click on the executable file to launch the BitKeeper installer. The installer will take a series of steps. The default installation is recommended for new users and can be accomplished by simply clicking on the Next, Okay, or yes buttons as they appear. The following is a more detailed look at the windows installation.

Once the installer is running, you may click Cancel at any time to abort the installation. In the first installation window, if you are in agreement with the license and copyright and are ready to proceed, click the Next button. The default destination folder is C:\Program Files\BitKeeper. If you would like to change the destination folder you may do that via the Browse... button. Once the destination folder is chosen, click on the Next button. In the next window, choose the Program Manager group, the default is BitKeeper. Once you choose the Program Manager group click the Next button. In the next window, you may choose Back to change a setting, Cancel to abort the installation, or Next to install the BitKeeper software.

BitKeeper requires cygwin and will attempt to install version 1.1.5 if it is not detected on the computer. Click Yes to install 1.1.5 or No to abort the installation. Read the message box with "Important Instruction" and click OK button when finished. To begin installation click Next. Choose Install From Local Directory and click Next. In the local package directory window click Next. Select the install root directory via Browse... button if the default is not correct. Make sure the "DOS text file type" and the correct "Install for" option are chosen and click Next.

At this point BitKeeper and cygwin should be installed and the BitKeeper regression tests should be run to verify the installation. Please contact support@bitmover.com if there are problems regarding the installation.

Verifying the installation

BitKeeper should now be installed. To verify, run the bk regression tests on the system as follows:

bk regression

At this point you should have downloaded BitKeeper, installed it, and run the regression tests on your system. If the regression tests did not pass please send mail to support@bitmover.com.

Getting a License

BitKeeper has three licensing models that are implemented depending on the user's preferences:

• Single User License
• Multi-User License with Open Logging
• Commercial License

The use of BitKeeper with the Single User License is free. Please read the BitKeeper License for terms. If this model is appropriate for you, add lines to the BitKeeper/etc/config file as follows:

single_user:username single_host:hostname

The use of BitKeeper for multiple users with Open Logging is also free. Please read the BitKeeper License for terms. If this model is appropriate for you, add lines to the BitKeeper/etc/config file as follows:

single_user:username single_host:hostname

The use of BitKeeper for multiple users without Open Logging enabled requires a commercial license key. You can get a temporary license by sending an email request to bk_license@bitmover.com. The system is automated so responses should be almost immediate.

Once you have the license key add a line to BitKeeper/etc/config file:

license:license_key