ReadMe for ICU
Description: The introduction to the International Components for Unicode with instructions on building, installation, usage and other information about ICU.
Keywords: ICU; International Components for Unicode; what's new; readme; read me; introduction; downloads; downloading; building; installation;

# International Components for Unicode
ICU 2.6.1 ReadMe

Version: 2003-Sep-15
Copyright © 1997-2003 International Business Machines Corporation and others. All Rights Reserved.

## Table of Contents

## Introduction

Today's software market is a global one in which it is desirable to develop and maintain one application (single source/single binary) that supports a wide variety of languages. The International Components for Unicode (ICU) libraries provide robust and full-featured Unicode services on a wide variety of platforms to help this design goal. The ICU libraries provide support for:

- The latest version of the Unicode standard
- Character set conversions with support for over 200 codepages
- Locale data for more than 230 locales
- Language sensitive text collation (sorting) and searching based on the Unicode Collation Algorithm (=ISO 14651)
- Regular expression matching and Unicode sets
- Transformations for normalization, upper/lowercase, script transliterations (50+ pairs)
- Resource bundles for storing and accessing localized information
- Date/Number/Message formatting and parsing of culture specific input/output formats
- Calendar specific date and time manipulation
- Complex text layout for Arabic, Hebrew, Indic and Thai
- Text boundary analysis for finding characters, word and sentence boundaries

ICU has a sister project ICU4J that extends the internationalization capabilities of Java to a level similar to ICU. The ICU C/C++ project is also called ICU4C when a distinction is necessary.

## Getting started

This document describes how to build and install ICU on your machine. For other information about ICU please see the following table of links.
The ICU homepage also links to related information about writing internationalized software.

Here are some useful links regarding ICU and internationalization in general.
ICU Homepage | http://oss.software.ibm.com/icu/index.html
ICU4J Homepage | http://oss.software.ibm.com/icu4j/index.html
FAQ - Frequently Asked Questions about ICU | http://oss.software.ibm.com/icu/userguide/icufaq.html
ICU User's Guide | http://oss.software.ibm.com/icu/userguide/index.html
Download ICU Releases | http://oss.software.ibm.com/icu/download/index.html
API Documentation Online | http://oss.software.ibm.com/icu/apiref/index.html
Online ICU Demos | http://oss.software.ibm.com/icu/demo/index.html
Contacts and Bug Reports/Feature Requests | http://oss.software.ibm.com/icu/archives/index.html

Important: Please make sure you understand the Copyright and License Information.

## What is new in this release?

This is a maintenance release - mostly concentrated on bug fixes. The most important feature is support for UCA 4.0. For more details, please see the ICU 2.6.1 download page.

The following list concentrates on changes in ICU 2.6 that affect existing applications migrating from previous ICU releases. For more news about this release, see the ICU 2.6 download page.

### Library Initialization

ICU4C 2.6 introduces a library initialization function. It is required to call it before using any ICU services in a multi-threaded environment. For details please see the documentation of `u_init()` in the `unicode/uclean.h` header file.

### Support for Unicode 4.0

Unicode properties and algorithms have been upgraded to Unicode 4.0, which includes the addition of 1226 new encoded characters. The UCA (Unicode Collation Algorithm) table is still at version 3.1.1, with Unicode 4-based canonical closure, because UCA 4 is not available yet. All Unicode properties (except for those in Unihan.txt) are now available via direct APIs, and most via UnicodeSet.

Note that a Unicode update includes changes in algorithms. For example, the default iterator for finding titlecasing positions has changed from the titlecasing iterator to the word break iterator according to the Unicode Standard.

Unicode 4 fixes 5 normalization bugs, which changes the decomposition and canonical equivalence of 5 characters. ICU 2.6 normalization uses Unicode 4 data, therefore it contains these bug fixes.

### Currency formatting

Formatting of currency values has been improved in ICU 2.6 by allowing the specification of any currency with any language-specific formatter. The currency itself can be chosen independently of the display language, but an appropriately localized string will be displayed for the currency symbol. The display symbol data is not fully fleshed out. See the API references for ucurr.h and NumberFormat. `icu/source/samples/numfmt/` is updated to illustrate this feature.

### XML resource bundles

The ICU team had developed a custom XML format that matched the capabilities of the binary data structure of ICU .res files. This format was not known to be used and not optimal for translation/localization. ICU 2.6 supports the standard XLIFF format for product localization by providing tools to convert between .xlf and ICU .txt files. See the User Guide Localizing with ICU chapter for details. The previous, ICU-specific XML format has been withdrawn.

### ICU code library size

ICU code libraries can be made smaller by removing functionality. See the Packaging ICU section of the User's Guide.

### Flexible data loading

ICU 2.2 has an extended search path functionality, more flexible data override capabilities, and removes lesser-known heuristics for determining the data path.

- Performance: ICU will only load data from packages, not from single files, when the search path is empty. This eliminates all file system accesses after the packages (ICU data + application data) are loaded.
  If this is important, then an application should set the search path to the empty path during initialization.
- Customizability: If the search path is not empty, then ICU searches for single files before looking in packages, allowing to override/update packaged data.
- User data: The new function ucnv_openPackage allows an application to load an ICU character mapping table from its own data. This enables applications to support more codepages than the ICU installation that it uses.
- Separation between ICU data and user data: Single data files must now always have a package name as prefix, which results in different file names between ICU and all application packages even for the same locale IDs etc.
- Multi-path: The search path can now contain multiple folders and can list packages directly instead of just a single folder.
- Predictability: The search path can be set via the ICU_DATA environment variable or via the `u_setDataDirectory()` function.
  ICU does not perform any other heuristics any more.

Note: while some of the old binary data may be still readable by ICU 2.2 (resource bundles, for example), they need to be repackaged in order to be used.

- If you have individual binary files, you have to rename them so that you prepend a `'packagename_'`. Then use `packagename` for opening.
- If you have a memory-mapped package file, you will need to unpack it (use decmn tool), rename individual files as above (prepending the package name), and repack the files.
- If you have a shared library file, you'll need to somehow get individual files and repackage them.

### Experimental locales moved to new repository

Experimental locales are ones for which we have incomplete data. Data for such locales used to be included in the default ICU download, but have been moved to a new locale data repository, stored as another ICU CVS module. This data can be added back into a customized ICU build, see the User Guide Data chapter. It can also still be viewed with the LocaleExplorer demo.

## How To Download the Source Code

There are two ways to download ICU releases:

- Official Release Snapshot:
  If you want to use ICU (as opposed to developing it), you should download an official packaged version of the ICU source code. These versions are tested more thoroughly than day-to-day development builds of the system, and they are packaged in zip and tar files for convenient download. These packaged files can be found at http://oss.software.ibm.com/icu/download/index.html.
  The packaged snapshots are named icu-nnnn.zip or icu-nnnn.tgz, where nnnn is the version number. The .zip file is used for Windows platforms, while the .tgz file is preferred on most other platforms.
  Please unzip this file. It will reconstruct the source directory, which includes anonymous CVS control directories (see below).
- CVS Source Repository:
  If you are interested in developing features, patches, or bug fixes for ICU, you should probably be working with the latest version of the ICU source code. You will need to check the code out of our CVS repository to ensure that you have the most recent version of all of the files. See our CVS page for details.

## ICU Source Code Organization

In the descriptions below, <ICU> is the full path name of the icu directory (the top level directory from the distribution archives) in your file system. You can also view the User's Guide to see which libraries you need for your software product. You need at least the data (`[lib]icudt`) and the common (`[lib]icuuc`) libraries in order to use ICU.

The following files describe the code drop.
File | Description
--- | ---
readme.html | Describes the International Components for Unicode (this file)
license.html | Contains the text of the ICU license

The following directories contain source code and data files.
Directory | Description
--- | ---
<ICU>/source/common/ | The core Unicode and support functionality, such as resource bundles, character properties, locales, codepage conversion, normalization, Unicode properties, Locale, and UnicodeString.
<ICU>/source/i18n/ | Modules in i18n are generally the more data-driven, that is to say resource bundle driven, components. These deal with higher-level internationalization issues such as formatting, collation, text break analysis, and transliteration.
<ICU>/source/data/ | This directory contains the source data in text format, which is compiled into binary form during the ICU build process. It contains several subdirectories, in which the data files are grouped by function. Note that the build process must be run again after any changes are made to this directory. brkitr/ Data files for character, word, sentence, title casing and line boundary analysis. locales/ These .txt files contain ICU language and culture-specific localization data. Two special bundles are root, which is the fallback data and parent of other bundles, and index, which contains a list of installed bundles. The makefile resfiles.mk contains the list of resource bundle files. mappings/ Here are the code page converter tables. These .ucm files contain mappings to and from Unicode. These are compiled into .cnv files. convrtrs.txt is the alias mapping table from various converter name formats to ICU internal format and vice versa. It produces cnvalias.icu. The makefiles ucmfiles.mk, ucmcore.mk, and ucmebcdic.mk contain the list of converters to be built. translit/ This directory contains transliterator rules as resource bundles, a makefile trnsfiles.mk containing the list of installed system translitaration files, and as well the special bundle translit_index which lists the system transliterator aliases. unidata/ This directory contains the Unicode data files. Please see http://www.unicode.org/ for more information. misc/ The misc directory contains other data files which did not fit into the above categories. Currently it only contains timezone.txt, a generated file, which is compiled into tz.dat. The tz.dat file contains time zone information. out/ This directory contains the assembled memory mapped files. out/build/ This directory contains intermediate (compiled) files, such as .cnv, .res, etc.
<ICU>/source/test/intltest/ | A test suite including all C++ APIs. For information about running the test suite, see the users' guide.
<ICU>/source/test/cintltst/ | A test suite written in C, including all C APIs. For information about running the test suite, see the users' guide.
<ICU>/source/test/testdata/ | Source text files for data, which are read by the tests. It contains the subdirectories out/build/ which is used for intermediate files, and out/ which contains the files test1.cnv through test4.cnv, and testdata.dat. Note that the tests call u_setDataDirectory("<ICU>/source/test/testdata/lib"), so that ICU will load these files as if they were part of the ICU data package, for testing purposes. This was formerly accomplished by setting the ICU_DATA environment variable to point at these files. ICU_DATA should not be set under normal circumstances.
<ICU>/source/tools/ | Tools for generating the data files. Data files are generated by invoking <ICU>/source/data/build/makedata.bat on Win32 or <ICU>/source/make on Unix.
<ICU>/source/samples/ | Various sample programs that use ICU
<ICU>/source/extra/ | Non-supported API additions. Currently, it contains the 'ustdio' file i/o library
<ICU>/source/layout/ | Contains the ICU layout engine (not a rasterizer).
<ICU>/packaging/ <ICU>/debian/ | These directories contain scripts and tools for packaging the final ICU build for various release platforms.
<ICU>/source/config/ | Contains helper makefiles for platform specific build commands. Used by 'configure'.
<ICU>/source/allinone/ | Contains top-level ICU workspace and project files, for instance to build all of ICU under one MSVC project.
<ICU>/bin/ | Contains the libraries and executables for using ICU on Windows.
<ICU>/include/ | Contains the headers needed for developing software that uses ICU on Windows.

## How To Build And Install ICU

### Supported Platforms

Here is a status of functionality of ICU on several different platforms.
Operating system | Compiler | Testing frequency
--- | --- | ---
Windows 2000/XP | Microsoft Visual C++ 6.0 | Reference platform
Windows XP | Microsoft Visual C++ .NET 2002 (7.0) | Reference platform
Red Hat Linux 7.2 | gcc 2.96 | Reference platform
AIX 5.1.0 L | Visual Age C++ 5.0 | Reference platform
Solaris 7 (SunOS 5.7) | Workshop Pro (Forte) CC 6.0 | Reference platform
HP-UX 11.01 | aCC A.12.10 cc A.11.01.00 | Reference platform
Windows NT/98 | Microsoft Visual C++ 6.0 | Regularly tested
Mac OS X (10.2) | gcc 3.1 (Developer Tools, July 2002) | Regularly tested
Solaris 8 (SunOS 5.8) | Workshop Pro CC 4.2 (use 'runConfigureICU SOLARISCC/W4.2') | Regularly tested
Solaris 2.6 (SunOS 5.6) | gcc 2.95.2 | Regularly tested
FreeBSD 4.4 | gcc 2.95.3 | Regularly tested
Red Hat Alpha Linux 7.2 | gcc 2.96 | Regularly tested
z/OS 1.2 | cxx 1.2 | Regularly tested
OS/400 (iSeries) V5R1 | iCC | Regularly tested
Red Hat Alpha Linux 7.2 | Compaq C++ Compiler 3.2 Compaq C Compiler 6.5.6 | Rarely tested
AIX 4.3.3 | xlC_r 4.0.2.1 | Rarely tested
CygWin | gcc 2.95.3 | Rarely tested
HP-UX 11.01 | CC A.03.10 | Rarely tested
QNX | gcc | Rarely tested
NetBSD, OpenBSD | gcc | Rarely tested
SGI/IRIX |  | Rarely tested
Tru64 (OSF) | Compaq's cxx compiler | Rarely tested

#### Key to testing frequency

Reference platform
  ICU will work on these platforms with these compilers
Regularly tested
  ICU should work on these platforms with these compilers
Rarely tested
  ICU has been ported to these platforms but may not have been tested there recently

### How To Build And Install On Windows

Building International Components for Unicode requires:

- Microsoft NT 4.0 and above, or Windows 98 and above
- Microsoft Visual C++ 6.0 (Service Pack 2 is required to work with the release build of max speed optimization).

(If you want to build with Microsoft Visual C++ .NET, please refer to the note about building with Visual Studio .NET below.)

The steps are:

1. Unzip the icu-XXXX.zip file into any convenient location. Using command line zip, type "unzip -a icu-XXXX.zip -d drive:\directory", or just use WinZip.
2. Be sure that the ICU binary directory, <ICU>\bin\, is included in the PATH environment variable. The tests will not work without the location of the ICU DLL files in the path.
3. Set the TZ environment variable to PST8PDT. The tests will not work in any other time zone.
4. Open the "<ICU>\source\allinone\allinone.dsw" workspace file in Microsoft Visual C++ 6.0. (This workspace includes all the International Components for Unicode libraries, necessary ICU building tools, and the intltest and cintltest test suite projects). Please see the note below if you want to build from the command line instead.
5. Set the active Project to the "all" project. To do this: Choose "Project" menu, and select "Set active project". In the submenu, select the "all" workspace.
6. Set the active configuration to "Win32 Debug" or "Win32 Release" (See note below).
7. Choose the "Build" menu and select "Rebuild All". If you want to build the Debug and Release at the same time, see the note below.
8. Run the C++ test suite, "intltest". To do this: set the active project to "intltest", and press F5 to run it.
9. Run the C test suite, "cintltst". To do this: set the active project to "cintltst", and press F5 to run it.
10. Make sure that both "cintltst" and "intltest" passed without any errors. The return codes are non-zero when they do not pass. Visual C++ will display the return codes in the debug tag of the output window. When "intltest" and "cintltest" return 0, it means that everything is installed correctly. You can press Ctrl+F5 on the test project to run the test and see what error messages were displayed (if any tests failed).
11. Reset the TZ environment variable to its original value, unless you plan on testing ICU any further.
12. You are now able to develop applications with ICU by using the libraries and tools in <ICU>\bin\. The headers are in <ICU>\include\ and the link libraries are in <ICU>\lib\. To install the ICU runtime on a machine, or ship it with your application, copy the needed components from <ICU>\bin\ to a location on the system PATH or to your application directory.

Using MSDEV At The Command Line Note: You can build ICU from the command line. Assuming that you have properly installed Microsoft Visual C++ to support command line execution, you can run the following command, 'msdev <ICU>\source\allinone\allinone.dsw /MAKE "ALL"'.

Setting Active Configuration Note: To set the active configuration, two different possibilities are:

- Choose "Build" menu, select "Set Active Configuration", and select "Win32 Release" or "Win32 Debug".
- Another way is to select "Customize" in the "Tools" menu, select the "Toolbars" tab, enable "Build" instead of "Build Minibar", and click on "Close". This will bring up a toolbar which you can move aside the other permanent toolbars at the top of the MSVC window. The advantage is that you now have an easy-to-reach pop-up menu that will always show the currently selected active configuration. Or, you can drag the project and configuration selections and drop them on the menu bar for later selection.

Batch Configuration Note: If you want to build the Debug and Release configurations at the same time, choose "Build" menu and select "Batch Build..." instead (and mark all configurations as checked), then click the button named "Rebuild All". The "all" workspace will build all the libraries, test programs and various ICU tools (e.g. genrb for generating binary locale data files).

Microsoft Visual Studio .NET Note: ICU will build with Microsoft Visual Studio .NET 2002. It is recommended that you use the "<ICU>\source\allinone\allinone.sln" solution workspace to build ICU. The instructions for building with Visual Studio .NET are similar to the instructions for Visual Studio .NET. If you have Microsoft Visual Studio .NET 2003 the Visual Studio .NET 2002 project files will automatically be converted to 2003 project files when you open the solution workspace for the first time.

### How To Build And Install On Windows XP on IA64

Building International Components for Unicode requires:

- Microsoft XP on an IA64 (Itanium®) machine
- Microsoft Visual C++ 6.0 (Service Pack 2 is required to work with the release build of max speed optimization).
- Microsoft Platform SDK.

The steps are:

1. Follow steps 1-3 in the in the previous section.
2. Open the "Set Windows XP 64-bit Build Environment (Retail)" command window from the Microsoft Platform SDK.
3. Use cd to get into the <ICU> directory.
4. Run this command: 'msdev /USEENV <ICU>\source\allinone\allinone.dsw /MAKE "all - Win64 Release"'
5. Run "cd source\test\intltest\Release"
6. Run the C++ test suite, "intltest". There should be no errors.
7. Run "cd ..\..\cintltst\Release"
8. Run the C test suite, "cintltst". There should be no errors.
9. Follow the last two steps in the in the previous section.

### How To Build And Install On Unix

Building International Components for Unicode on Unix requires:

- A C++ compiler installed on the target machine (for example: gcc, CC, xlC_r, aCC, cxx, etc...).
- An ANSI C compiler installed on the target machine (for example: cc).
- A recent version of GNU make (3.77+).
- For a list of z/OS tools please view the z/OS build section of this document for further details.

Here are the steps to build ICU:

1. Decompress the icu-X.Y.tgz (or icu-X.Y.tar.gz) file. For example, `"gunzip -d < icu-X.Y.tgz | tar xvf -"`
2. Change directory to the "icu/source".
3. Run `"chmod +x runConfigureICU configure install-sh"` because these files may have the wrong permissions.
4. Run the `runConfigureICU` script for your platform. (See note below).
5. Type `"gmake"` (or "make" if GNU make is the default make on your platform) to compile the libraries and all the data files. The proper name of the GNU make command is printed at the end of the configuration run, as in "You must use gmake to compile ICU".
6. Optionally, type `"gmake check"` to run the test suite, which checks for ICU's functionality integrity (See note below).
7. Type `"gmake install"` to install ICU. If you used the --prefix= option on configure or runConfigureICU, ICU will be installed to the directory you specified. (See note below).

Configuring ICU NOTE: Type `"./runConfigureICU --help"` for help on how to run it and a list of supported platforms. You may also want to type `"./configure --help"` to print the available configure options that you may want to give runConfigureICU. If you are not using the runConfigureICU script, or your platform is not supported by the script, you may need to set your CC, CXX, CFLAGS and CXXFLAGS environment variables, and type `"./configure"`. Some of the more frequently used options to configure are --disable-64bit-libs to create 32-bit libraries, and --srcdir to do out of source builds (build the libraries in the current location). HP-UX user's, please see this note regarding multithreaded build issues with newer compilers.

Running The Tests From The Command Line NOTE: You may have to set certain variables if you with to run test programs individually, that is apart from "gmake check". The TZ environment variable needs to be set to PST8PDT. Also, the environment variable ICU_DATA can be set to the full pathname of the data directory to indicate where the locale data files and conversion mapping tables are when you are not using the shared library (e.g. by using the .dat archive or the individual data files). The trailing "/" is required after the directory name (e.g. "$Root/source/data/out/" will work, but the value "$Root/source/data/out" is not acceptable). You do not need to set ICU_DATA if the complete shared data library is in your library path.

Installing ICU NOTE: Some platforms use package management tools to control the installation and uninstallation of files on the system, as well as the integrity of the system configuration. You may want to check if ICU can be packaged for your package management tools by looking into the "packaging" directory. (Please note that if you are using a snapshot of ICU from CVS, it is probable that the packaging scripts or related files are not up to date with the contents of ICU at this time, so use them with caution).

### How To Build And Install On z/OS (OS/390)

You can install ICU on z/OS or OS/390 (the previous name of z/OS), but IBM tests only the z/OS installation. These platforms commonly are called "MVS". You install ICU in a z/OS UNIX system services file system such as HFS or zFS. On this platform, it is important that you understand a few details:

- APAR PQ58392 may be needed by z/OS 1.2 or 1.3 in order to get some ICU number formatting functions to work properly. The APAR affects C and C++ code.
- The gnu utilities gmake and gzip/gunzip are needed and can be obtained for z/OS from z/OS Unix - Tools and Toys. Documentation on these tools can be found at the Open Source Software for z/OS UNIX Red Book.
- Encoding considerations: The source code assumes that it is compiled with codepage ibm-1047 (to be exact, the UNIX System Services variant of it). The pax command converts all of the source code files from ASCII to codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and must not be converted, or must be converted back to their original state. You can use the unpax-icu.sh script to do this for you automatically. It will unpackage the tar file and convert all the necessary files for you automatically.

- z/OS supports both native S/390 hexadecimal floating point and, (with OS/390 2.6 and later) IEEE binary floating point. This is a compile time option. Applications built with IEEE should use ICU DLLs that are built with IEEE (and vice versa). The environment variable IEEE390=1 will cause the z/OS version of ICU to be built with IEEE floating point. The default is native hexadecimal floating point.
  Important: Currently (ICU 1.4.2), native floating point support is sufficient for codepage conversion, resource bundle and UnicodeString operations, but the Format APIs, especially ChoiceFormat, require IEEE binary floating point.

  Examples for configuring ICU:
  Debug build: `IEEE390=1 ./runConfigureICU --enable-debug zOS`
  Release build: `IEEE390=1 ./runConfigureICU zOS`

- z/OS introduced the concept of Extra Performance Linkage (XPLINK) to bring performance improvement opportunities to call-intensive C and C++ applications such as ICU. XPLINK is enabled on a DLL-by-DLL basis, so if you are considering using XPLINK in your application that uses ICU, you should consider building the XPLINK-enabled version of ICU. You need to set ICU's environment variable `OS390_XPLINK=1` prior to invoking the make process to produce binaries that are enabled for XPLINK.

  Note: XPLINK, enabled for z/OS 1.2 and later, requires the PTF for PQ69418 to build XPLINK-enabled binaries.

- Since the default make on z/OS is not gmake, the pkgdata tool requires that the "make" command is aliased to your installed version of gmake. You may also need to set $MAKE equal to the fully qualified path of GNU make. GNU make is available with the "z/OS Unix - Tools and Toys" that was mentioned above. The required version is the same Unix build instructions.
- The makedep executable that is used with the z/OS ICU build process is not shipped with ICU. It is available at the z/OS Unix - Tools and Toys site. The PATH environment variable should be updated to contain the location of this executable prior to build. Alternatively, makedep may be moved into an existing PATH directory.

- When you build ICU on a system such as z/OS 1.2, the binaries that result can run on that level of the operating system and later, such as z/OS 1.3 and z/OS 1.4. It's possible that you may have a z/OS 1.4 system and, for example, need to deliver binaries on z/OS 1.2 and above. z/OS gives you this ability by targeting the complier and linker to run at the older level, thereby producing the desired binaries.

  To set the compiler and LE environment to OS/390 2.10, specify the following:

      ./runConfigureICU OS390V2R10

  To set the compiler and LE environment to z/OS 1.2 specify the following:

      ./runConfigureICU zOSV1R2

- The rest of the instructions for building and testing ICU on z/OS with Unix System Services are the same as the How To Build And Install On Unix section.

#### z/OS (Batch/PDS) support outside the UNIX system services environment

By default, ICU builds its libraries into the UNIX file system (HFS). In addition, there is a z/OS specific environment variable (OS390BATCH) to build some libraries into the z/OS native file system. This is useful, for example, when your application is externalized via Job Control Language (JCL).

The OS390BATCH environment variable enables non-UNIX support including the batch environment. When OS390BATCH is set, the libicuucXX.dll, libicudtXXe.dll, and libicudtXXe_stub.dll binaries are built into data sets (the native file system). Turning on OS390BATCH does not turn off the normal z/OS UNIX build. This means that the z/OS UNIX (HFS) DLLs will always be created.

Two additional environment variables indicate the names of the z/OS data sets to use. The LOADMOD environment variable identifies the name of the data set that contains the dynamic link libraries (DLLs) and the LOADEXP environment variable identifies the name of the data set that contains the side decks, which are normally the files with the .x suffix in the UNIX file system.

A data set is roughly equivalent to a UNIX or Windows file. For most kinds of data sets the operating system maintains record boundaries. UNIX and Windows files are byte streams. Two kinds of data sets are PDS and PDSE. Each data set of these two types contains a directory. It is like a UNIX directory. Each "file" is called a "member". Each member name is limited to eight bytes, normally EBCDIC.

Here is an example of some environment variables that you can set prior to building ICU:

    OS390BATCH=1
    LOADMOD=USER.ICU.LOAD
    LOADEXP=USER.ICU.EXP

The PDS member names for the DLL file names are as follows:

    IXMIXXUC --> libicuucXX.dll
    IXMIXXDA --> libicudtXXe.dll
    IXMIXXD1 --> libicudtXXe_stub.dll (Only when OS390_STUBDATA=1)

You should point the LOADMOD environment variable at a partitioned data set extended (PDSE) and point the LOADEXP environment variable at a partitioned data set (PDS). The PDSE can be allocated with the following attributes:

    Data Set Name . . . : USER.ICU.LOAD
    Management class. . : **None**
    Storage class . . . : BASE
    Volume serial . . . : TSO007
    Device type . . . . : 3390
    Data class. . . . . : LOAD
    Organization  . . . : PO
    Record format . . . : U
    Record length . . . : 0
    Block size  . . . . : 32760
    1st extent cylinders: 1
    Secondary cylinders : 5
    Data set name type  : LIBRARY

The PDS can be allocated with the following attributes:

    Data Set Name . . . : USER.ICU.EXP
    Management class. . : **None**
    Storage class . . . : BASE
    Volume serial . . . : TSO007
    Device type . . . . : 3390
    Data class. . . . . : **None**
    Organization  . . . : PO
    Record format . . . : FB
    Record length . . . : 80
    Block size  . . . . : 3200
    1st extent cylinders: 3
    Secondary cylinders : 3
    Data set name type  : PDS

### How To Build And Install On OS/400 (iSeries)

Before you start building ICU, ICU requires the following:

- QSHELL interpreter installed (install base option 30, operating system)
- ILE C/C++ Compiler for iSeries, LPP 5722-WDS
- The latest GNU facilities (You can get the GNU facilities for OS/400 from http://www.as400.ibm.com/developer/factory/porting/gnu_utilities.html). Older versions may not work properly.

The following describes how to setup and build ICU. For background information, you should look at the Unix build instructions.

1. Create AS400 target library. This library will be the target for the resulting modules, programs and service programs. You will specify this library on the OUTPUTDIR environment variable in step 2.

       CRTLIB LIB(libraryname)

2. Set up the following environment variables in your build process (use the libraryname from the previous step)

       ADDENVVAR ENVVAR(CC) VALUE('/usr/bin/icc')
       ADDENVVAR ENVVAR(CXX) VALUE('/usr/bin/icc')
       ADDENVVAR ENVVAR(MAKE) VALUE('/usr/bin/gmake')
       ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('libraryname')

   libraryname identifies target as400 library for *module, *pgm and *srvpgm objects.
3. In order to get the tests to run correctly, the QUTCOFFSET needs to be set to the Pacific Time Zone offset.
   To check your QUTCOFFSET:

       DSPSYSVAL SYSVAL(QUTCOFFSET)

   To change your QUTCOFFSET:

       CHGSYSVAL SYSVAL(QUTCOFFSET) VALUE('-0800')

   You should change -0800 to -0700 for daylight savings.
4. Run `'CHGJOB CCSID(37)'`
5. Run `'QSH'`
6. Run gunzip on the ICU source code compressed tar archive (icu-X.Y.tgz or icu-X.Y.tar.gz).
7. Run unpax-icu.sh on the tar file from the ICU download page.
8. Change your current directory to icu/source.
9. Run `'export CFLAGS=-O4 CXXFLAGS=-O4'` to optimize your build of ICU. If the build fails, rerun these build steps without this step before asking the icu4c-support mailing list for help.
10. Run `'cp ../as_is/os400/configure .'`
11. Run `'./configure --host=as400-os400'`
12. If you specified `--with-data-packaging=archive` to configure, you can skip this step. In a future release of ICU, we hope to eliminate this complicated step. Any suggestions to improve the ICU installation are greatly appreciated, and you can send those suggestions to the icu4c-support mailing list.
    1. Run `'mv data/Makefile data/Makefile.hide'`
    2. Run `'gmake'` to build some of the ICU libraries.
    3. When the gmake command fails in icu/source/data, run the following commands to setup and build the data library:

           cd data
           mv Makefile.hide Makefile
           system CRTLIB "LIB(datalibraryname)"
           gmake OUTPUTDIR=datalibraryname
           system CRTSRVPGM "SRVPGM(libraryname/LIBICUDATA)" "MODULE(datalibraryname/*ALL)"
                            "EXPORT(*ALL)" "TEXT('ICU 2.6 DATA')" "OPTION(*DUPPROC *DUPVAR)"
           ln -fs /qsys.lib/libraryname.lib/libicudata.srvpgm out/libicudata.so
           cd ..
           del common/libicuuc.so

    4. Your data library should now be usable. Go to the next step, which is needed to rebind to the actual data library and finish the build.
13. Run `'gmake'` to build ICU.
14. Run `'gmake check'` to build the tests.
15. The "utility/MultithreadTest" test in intltest may have failed during `'gmake check'`. In order to make this test pass, please use `'gmake check QIBM_MULTI_THREADED=Y'` after you built the tests with `'gmake check'` from the previous step. You can look at the iSeries Information Center for more details.

## How To Package ICU

There are many ways that a person can package ICU with their software products. Usually only the libraries need to be considered for packaging.

On Unix, you should have used "`gmake install`" to make it easier to develop and package ICU. The bin, lib and include directories are needed to develop applications that use ICU. These directories will be created relative to the "`--prefix=`dir" configure option (See above). When ICU is built on Windows, a similar directory structure is built.

When changes have been made to the standard ICU distribution, it is recommended that at least one of the following guidelines be followed for special packaging.

1. Add a suffix name to the library names. This can be done with the --with-library-suffix configure option.
2. The installation script should install the ICU libraries into the application's directory.

Following these guidelines prevents other applications that use a standard ICU distribution from conflicting any libraries that you need. On operating systems that do not have a standard C++ ABI (name mangling) for compilers, it is recommended to do this special packaging anyway. More details on customizing ICU are available in the User's Guide. The ICU Source Code Organization section of this readme.html gives a more complete description of the libraries.

Here is an example of libraries that are frequently packaged.
Library Name | Windows Filename | Linux Filename | Comment
--- | --- | --- | ---
Data Library | icudtXYl.dll | libicudata.so.XY.Z | Data required by the Common and I18n libraries. There are many ways to package and customize this data, but by default this is all you need.
Common Library | icuucXY.dll | libicuuc.so.XY.Z | Base library required by all other ICU libraries.
Internationalization (i18n) Library | icuinXY.dll | libicui18n.so.XY.Z | Contains many locale based i18n functions.
Layout Engine | iculeXY.dll | libicule.so.XY.Z | Contains an optional engine for doing font layout.
Layout Extensions Engine | iculxXY.dll | libiculx.so.XY.Z | Contains an optional engine for doing font layout that uses parts of ICU.
Unicode stdio Library | icuioXY.dll | libustdio.so.XY.Z | An unsupported optional library that provides a stdio like API with Unicode support.

Normally only the above ICU libraries need to be considered for packaging. The versionless symbolic links to these libraries are only needed for easier development. The X, Y and Z parts of the name are the version numbers of ICU. For example, ICU 2.0.2 would have the name libicuuc.so.20.2 for the common library. The exact format of the library names can vary between platforms due to how each platform can handles library versioning.

## Important Notes About Using ICU

### Using ICU in a Multithreaded Environment

If you are using ICU in a multithreaded application, there may be a chance that the ICU global mutex is not initialized properly. Normally the ICU global mutex is initialized during C++ static initialization, but there are some compilers and linkers that do not properly perform C++ static initialization in a library. Here are some of the cases when the global mutex is not initialized:

- Static ICU libraries are used.
- ICU is used on Mac OS X
- ICU is used on HP-UX and the program's `main()` function is not declared in a C++ file.

Upon the first usage of most ICU APIs, the global mutex will get initialized, but you can use the `u_init()` function from uclean.h to ensure that it is initialized. Without one of these function calls from a single thread, the data caches inside ICU may get initialized more than once, which may cause memory leaks and other problems. This problem normally does not happen when C++ static initialization works properly.

ICU does not use C++ static initialization for anything else, and disabling threads in ICU will disable all C++ static initialization in ICU. If you do not have a multithreaded application, you do not need to worry about the global mutex.

#### Using ICU in a Multithreaded Environment on HP-UX

If you are building ICU with a newer aCC compiler, or you are planning on using any RogueWave libraries, you will need to set special flags before building ICU. These flags are needed in order to make ICU thread safe and to allow iostream to work properly. More information on these flags can be found here and here.

    CFLAGS="-mt" CXXFLAGS="-mt -AA" LDFLAGS="-mt" ./runConfigureICU HP-UX11ACC

### char * strings in ICU

The C/C++ languages do not provide a portable way to specify Unicode code point or string literals other than with arrays of numeric constants. For convenience, ICU4C tends to use char * strings in places where only "invariant characters" are used — a portable subset of the 7-bit ASCII repertoire — so that locale IDs, charset names, resource bundle item keys and similar can be easily specified as string literals in the source code. The same types of strings are also stored as "invariant character" char * strings in the ICU data files.

ICU has hardcoded mapping tables in `source/common/putil.c` to convert invariant characters to and from Unicode without using a full ICU converter. These tables must match the encoding of string literals in the ICU code as well as in the ICU data files.

Important: ICU assumes that at least the invariant characters always have the same codes as is common on platforms with the same charset family (ASCII vs. EBCDIC). ICU has not been tested on platforms where this is not the case.

Some usage of char * strings in ICU assumes the system charset instead of invariant characters; such strings are only handled with the default converter. See the following section. (The system charset is usually a superset of the invariant characters.)

The following are the ASCII and EBCDIC code values for all of the invariant characters (see also unicode/utypes.h):

Character(s) | ASCII | EBCDIC
--- | --- | ---
a..i | 61..69 | 81..89
j..r | 6A..72 | 91..99
s..z | 73..7A | A2..A9
A..I | 41..49 | C1..C9
J..R | 4A..52 | D1..D9
S..Z | 53..5A | E2..E9
0..9 | 30..39 | F0..F9
(space) | 20 | 40
" | 22 | 7F
% | 25 | 6C
& | 26 | 50
' | 27 | 7D
( | 28 | 4D
) | 29 | 5D
* | 2A | 5C
+ | 2B | 4E
, | 2C | 6B
- | 2D | 60
. | 2E | 4B
/ | 2F | 61
: | 3A | 7A
; | 3B | 5E
< | 3C | 4C
= | 3D | 7E
> | 3E | 6E
? | 3F | 6F
_ | 5F | 6D

### Using the default codepage

ICU has code to determine the default codepage of the system or process. This default codepage can be used to convert `char *` strings to and from Unicode.

Depending on system design, setup and APIs, it may not always be possible to find a default codepage that fully works as expected. For example,

- On Windows there are three encodings in use at the same time. Unicode (UTF-16) is always used inside of Windows, while for `char *` encodings there are two classes, called "ANSI" and "OEM" codepages. ICU will use the ANSI codepage. Note that the OEM codepage is used by default for console window output.
- On some Unix-type systems, non-standard names are used for encodings, or non-standard encodings are used altogether. Although ICU supports over 200 encodings in its standard build and many more aliases for them, it will not be able to recognize such non-standard names.
- Some systems do not have a notion of a system or process codepage, and may not have APIs for that.

If you have means of detecting a default codepage name that are more appropriate for your application, then you should set that name with `ucnv_setDefaultName()` as the first ICU function call. This makes sure that the internally cached default converter will be instantiated from your preferred name.

Starting in ICU 2.0, when a converter for the default codepage cannot be opened, a fallback default codepage name and converter will be used. On most platforms, this will be US-ASCII. For z/OS (OS/390), ibm-1047-s390 is the default fallback codepage. For AS/400 (iSeries), ibm-37 is the default fallback codepage. This default fallback codepage is used when the operating system is using a non-standard name for a default codepage, or the converter was not packaged with ICU. The feature allows ICU to run in unusual computing environments without completely failing.

### Windows Platform

If you are building on the Win32 platform, it is important that you understand a few of the following build details.

#### DLL directories and the PATH setting

As delivered, the International Components for Unicode build as several DLLs, which are placed in the "<ICU>\bin" directory. You must add this directory to the PATH environment variable in your system, or any executables you build will not be able to access International Components for Unicode libraries. Alternatively, you can copy the DLL files into a directory already in your PATH, but we do not recommend this. You can wind up with multiple copies of the DLL and wind up using the wrong one.

#### Changing your PATH

- Windows 2000: Use the System Icon in the Control Panel. Pick the "Advanced" tab. Select the "Environment Variables..." button. Select the variable PATH in the lower box, and select the lower "Edit..." button. In the "Variable Value" box, append the string ";<ICU>\bin" to the end of the path string. If there is nothing there, just type in "<ICU>\bin". Click the Set button, then the OK button.
- Windows NT: Use the System Icon in the Control Panel. Pick the "Environment" tab, and select the variable PATH in the lower box. In the "value" box, append the string ";<ICU>\bin" at the end of the path string. If there is nothing there, just type in "<ICU>\bin". Click the Set button, then the OK button.
- Windows 95/98/ME: Edit the autoexec.bat, and add the following line to the end of file, "SET PATH=%PATH%;<ICU>\bin"

Note: When packaging a Windows application for distribution and installation on user systems, copies of the ICU DLLs should be included with the application, and installed for exclusive use by the application. This is the only way to insure that your application is running with the same version of ICU, built with exactly the same options, that you developed and tested with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the phrase "DLL hell" on msdn.microsoft.com.

### Unix Type Platform

If you are building on a Unix platform, and if you are installing ICU in a non-standard location, you may need to add the location of your ICU libraries to your LD_LIBRARY_PATH or LIBPATH environment variable (or the equivalent runtime library path environment variable for your system). The ICU libraries may not link or load properly without doing this.

Note that if you do not want to have to set this variable, you may instead use the --enable-rpath option at configuration time. This option will instruct the linker to always look for the libraries where they are installed. You will need to use the appropriate linker options when linking your own applications and libraries against ICU, too. Please refer to your system's linker manual for information about runtime paths. The use of rpath also means that when building a new version of ICU you should not have an older version installed in the same place as the new version's installation directory, as the older libraries will used during the build, instead of the new ones, likely leading to an incorrectly build ICU. (This is the proper behavior of rpath.)

## Platform Dependencies

### Porting To A New Platform

If you are using ICU's Makefiles to build ICU on a new platform, there are a few places where you will need to add or modify some files. If you need more help, you can always ask the icu4c-support mailing list. Once you have finished porting ICU to a new platform, it is recommended that you contribute your changes back to ICU via the icu4c-support mailing list. This will make it easier for everyone to benefit from your work.

Try to follow the build steps from the Unix build instructions. If the configure script fails, then you will need to modify some files. Here are the usual steps for porting to a new platform:

1. Create an mh file in icu/source/config/. You can use mh-linux or a similar mh file as your base configuration.
2. Modify icu/source/aclocal.m4 to recognize your platform's mh file.
3. Modify icu/source/configure.in to properly set your platform C Macro define.
4. Run autoconf in icu/source/ without any options. The autoconf tool is standard on most Linux systems.
5. If you have any optimization options that you want to normally use, you can modify icu/source/runConfigureICU to specify those options for your platform.
6. Build and test ICU on your platform. It is very important that you run the tests. If you don't run the tests, there is no guarentee that you have properly ported ICU.

### Platform Dependent Implementations

The platform dependencies have been mostly isolated into the following files in the common library. This information can be useful if you are porting ICU to a new platform.

- unicode/platform.h.in (autoconf'ed platforms)
  unicode/pXXXX.h (others: pwin32.h, pmacos.h, ..): Platform-dependent typedefs and defines:
  - XP_CPLUSPLUS for C++ only.
  - TRUE and FALSE, UBool, int8_t, int16_t etc.
  - U_EXPORT and U_IMPORT for specifying dynamic library import and export
  - int64_t and uint64_t. If the platform does not support 64 bit values, the macro `U_INT64_T_UNAVAILABLE` must be defined. For example, this will disable Rule-based number formatting.
- unicode/putil.h, putil.c: platform-dependent implementations of various functions that are platform dependent:
  - uprv_isNaN, uprv_isInfinite, uprv_getNaN and uprv_getInfinity for handling special floating point values.
  - uprv_tzset, uprv_timezone, uprv_tzname and time for getting platform specific time and time zone information.
  - u_getDataDirectory for getting the default data directory.
  - uprv_getDefaultLocaleID for getting the default locale setting.
  - uprv_getDefaultCodepage for getting the default codepage encoding.
- umutex.h, umutex.c: Code for doing synchronization in multithreaded applications. If you wish to use International Components for Unicode in a multithreaded application, you must provide a synchronization primitive that the classes can use to protect their global data against simultaneous modifications. See Users' guide for more information.
  - We supply sample implementations for WinNT, Win95, Win98, Sun/Solaris, RedHat/Linux, HP-UX and for AIX on an RS/6000.
- umapfile.h, umapfile.c: functions for mapping or otherwise reading or loading files into memory. All access by ICU to data from files makes use of these functions.
- Using platform specific #ifdef macros are highly discouraged outside of the scope of these files. When the source code gets updated in the future, these #ifdef's can cause testing problems for your platform.

### Build Order Without Using ICU's Makefiles

It is possible to build each library individually without our Makefiles. They must be built in the following order:

1. stubdata
2. common
3. i18n
4. toolutil
5. makeconv
6. gencnval
7. genprops
8. gennames
9. genpname
10. gennorm
11. genidna
12. genbrk
13. genuca
14. genrb
15. gentz
16. genccode
17. gencmn
18. pkgdata
19. makedata (a project on Windows, or source/data/Makefile on Unix)
20. layout (optional)
21. layoutex (optional)
22. ctestfw, intltest and cintltst, if you want to run the test suite.
23. uconv and ustdio can also be optionally built.

Copyright © 1997-2003 International Business Machines Corporation and others. All Rights Reserved.
IBM Globalization Center of Competency - San José
5600 Cottle Road
San José, CA 95193
USA