Installation

- Installation Instructions for Windows
- Installation Instructions for UNIX/Mac OS X/Linux
- Installation Instructions for Cygwin

Windows

This section contains installation instructions for the Windows platform.

Source distribution

The &XercesCName; source is available in the source distribution: &XercesCSrcInstallDir;.zip.

Install the &XercesCName; source distribution by using `unzip` on the &XercesCSrcInstallDir;.zip archive in the Windows environment. You can use WinZip, or any other UnZip utility:

    unzip &XercesCSrcInstallDir;.zip

This creates the '&XercesCSrcInstallDir;' sub-directory containing the &XercesCName; source distribution.

If you need to build the &XercesCName; source after installation, please follow the Build Instructions.

Binary distribution

Install the &XercesCName; binary distribution by using `unzip` on the &XercesCInstallDir;-{arch}-windows-{compiler}.zip archive in the Windows environment. Here {arch} denotes the CPU architecture and {compiler} denotes the C++ compiler of your choice. You can use WinZip, or any other UnZip utility. For example:

    unzip &XercesCInstallDir;-x86-windows-vc_8_0.zip

This creates a '&XercesCInstallDir;-x86-windows-vc_8_0' sub-directory containing the &XercesCName; binary distribution.

You need to add the '&XercesCInstallDir;-{arch}-windows-{compiler}\bin' directory to your path. To do this go to the start menu, click the settings menu and select control panel. When the control panel opens, double click on System and select the 'Environment' tab. Locate the PATH variable under system variables and add <full-path-to-&XercesCInstallDir;-{arch}-windows-{compiler}>\bin to the PATH variable.

The binary distribution contains the pre-built parser libraries and sample executables. Please refer to the Samples for how to run the samples.

UNIX

This section contains installation instructions for the UNIX, Linux, and Mac OS X platforms.

Source distribution

The &XercesCName; source is available in the source distribution: &XercesCSrcInstallDir;.tar.gz.

Install the &XercesCName; source distribution &XercesCSrcInstallDir;.tar.gz by extracting the files from the compressed archive:

    gzip -d &XercesCSrcInstallDir;.tar.gz
    tar -xf &XercesCSrcInstallDir;.tar

This creates the '&XercesCSrcInstallDir;' sub-directory containing the &XercesCName; source distribution.

If you need to build the &XercesCName; source after installation, please follow the Build Instructions.

Binary distribution

Install the binary distribution &XercesCInstallDir;-{arch}-{os}-{compiler}.tar.gz by extracting the files from the compressed archive. Here {arch} denotes the CPU architecture, {os} denotes the operating system, and {compiler} denotes the C++ compiler of your choice. For example:

    gzip -d &XercesCInstallDir;-x86-linux-gcc_3_4.tar.gz
    tar -xf &XercesCInstallDir;-x86-linux-gcc_3_4.tar

This will create an '&XercesCInstallDir;-x86-linux-gcc_3_4' sub-directory containing the &XercesCName; binary distribution.

You will need to add the &XercesCInstallDir;-{arch}-{os}-{compiler}/bin directory to your PATH environment variable:

For Bourne Shell, K Shell or Bash, type:

    export PATH="$PATH:<full-path-to-&XercesCInstallDir;-{arch}-{os}-{compiler}>/bin"

For C Shell, type:

    setenv PATH "$PATH:<full-path-to-&XercesCInstallDir;-{arch}-{os}-{compiler}>/bin"

If you wish to make this setting permanent, you need to change your profile by changing your setup files which can be either .profile or .kshrc.

In addition, you will also need to set the library search path. (LIBPATH on AIX, LD_LIBRARY_PATH on Solaris and Linux, SHLIB_PATH on HP-UX, and DYLD_LIBRARY_PATH on Mac OS X).

In the following shell commands, the <xerces-path> denotes the full path to the &XercesCInstallDir;-{arch}-{os}-{compiler} directory. For Bourne Shell, K Shell or Bash, type:

    export LIBPATH=<xerces-path>/lib:$LIBPATH (AIX)
    export LD_LIBRARY_PATH=<xerces-path>/lib:$LD_LIBRARY_PATH (Solaris, Linux)
    export SHLIB_PATH=<xerces-path>/lib:$SHLIB_PATH (HP-UX)
    export DYLD_LIBRARY_PATH=<xerces-path>/lib:$DYLD_LIBRARY_PATH (Mac OS X)

For C Shell, type:

    setenv LIBPATH "<xerces-path>/lib:$LIBPATH" (AIX)
    setenv LD_LIBRARY_PATH "<xerces-path>/lib:$LD_LIBRARY_PATH" (Solaris, Linux)
    setenv SHLIB_PATH "<xerces-path>/lib:$SHLIB_PATH" (HP-UX)
    setenv DYLD_LIBRARY_PATH "<xerces-path>/lib:$DYLD_LIBRARY_PATH" (Mac OS X)

The binary distribution contains the pre-built parser libraries and sample executables. Please refer to the Samples for how to run the samples.

Cygwin

This section contains installation instructions for the Cygwin platform.

Source distribution

The &XercesCName; source is available in the source distribution: &XercesCSrcInstallDir;.tar.gz.

Install the &XercesCName; source distribution &XercesCSrcInstallDir;.tar.gz by extracting the files from the compressed archive:

    tar -xfz &XercesCSrcInstallDir;.tar.gz

This creates the '&XercesCSrcInstallDir;' sub-directory containing the &XercesCName; source distribution.

If you need to build the &XercesCName; source after installation, please follow the Build Instructions.

Binary distribution

Install the binary distribution by running Cygwin setup.exe. When you reach the "Packages" step of the Cygwin Setup wizard, expand the "Devel" category, then click in the "New" column next to "xerces-c-devel" until it reads "&XercesCVersion;-X".

This will install the necessary libraries and include files for the &XercesCName; binary distribution.

If you wish to run programs linked to &XercesCName; that were built in the Cygwin environment, you need to add your Cygwin "bin" directory to your Windows PATH environment variable. In typical Cygwin installations, the bin directory is in the Cygwin directory on the drive that windows is installed on. For instance, if windows is installed to "C:\Windows\System32", Your Cygwin bin directory may be "C:\cygwin\bin".

The binary distribution contains the pre-built parser libraries. Sample executables may be available in a future release on the Cygwin platform. In the meantime, they may be built from the source distribution by following the Build Instructions for "Building samples".