organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-21 12:40:02 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 1

ICU-3027 Fix some grammatical errors and some spelling/capitalization inconsistencies.

Browse source 
X-SVN-Rev: 13413
This commit is contained in:
George Rhoten 2003-10-14 18:30:25 +00:00
parent 4098ce1994
commit 0f41769317
1 changed files with 73 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

150
icu4c/readme.html
View file

@ -59,7 +59,7 @@
<li><a href="#HowToBuildWindowsXP64">Windows XP on IA64</a></li>
<li><a href="#HowToBuildUnix">Unix</a></li>
<li><a href="#HowToBuildUNIX">UNIX</a></li>
<li><a href="#HowToBuildZOS">z/OS (os/390)</a></li>
@ -83,7 +83,7 @@
<li><a href="#ImportantNotesWindows">Windows Platform</a></li>
<li><a href="#ImportantNotesUnix">Unix Type Platforms</a></li>
<li><a href="#ImportantNotesUNIX">UNIX Type Platforms</a></li>
</ul>
</li>
@ -232,7 +232,7 @@
<h3>Library Initialization</h3>
<p>ICU4C 2.6 introduces a library initialization function. It is required
to call&nbsp; it before using any ICU services in a multi-threaded
to call it before using any ICU services in a multi-threaded
environment. For details please see the <a href=
"http://oss.software.ibm.com/icu/apiref/index.html">documentation</a> of
<code>u_init()</code> in the <code>unicode/uclean.h</code> header file.</p>
@ -272,7 +272,7 @@
Organization</a></h2>
<p>In the descriptions below, <strong><i>&lt;ICU&gt;</i></strong> is the
full path name of the icu directory (the top level directory from 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 <a href=
"http://oss.software.ibm.com/icu/userguide/design.html">ICU Architectural
Design</a> section of the User's Guide to see which libraries you need for
@ -423,7 +423,7 @@
<td>Tools for generating the data files. Data files are generated by
invoking <i>&lt;ICU&gt;</i>/source/data/build/makedata.bat on Win32 or
<i>&lt;ICU&gt;</i>/source/make on Unix.</td>
<i>&lt;ICU&gt;</i>/source/make on UNIX.</td>
</tr>
<tr>
@ -773,11 +773,12 @@
the "all" workspace.</li>
<li>Set the active configuration to "Win32 Debug" or "Win32 Release" (See
<a href="#HowToBuildWindowsConfig">note</a> below).</li>
<a href="#HowToBuildWindowsConfig">Windows configuration note</a>
below).</li>
<li>Choose the "Build" menu and select "Rebuild All". If you want to
build the Debug and Release at the same time, see the <a href=
"#HowToBuildWindowsBatch">note</a> below.</li>
"#HowToBuildWindowsBatch">batch configuration note</a> below.</li>
<li>Run the C++ test suite, "intltest". To do this: set the active
project to "intltest", and press F5 to run it.</li>
@ -890,10 +891,10 @@
previous section</a>.</li>
</ol>
<h3><a name="HowToBuildUnix" href="#HowToBuildUnix">How To Build And
Install On Unix</a></h3>
<h3><a name="HowToBuildUNIX" href="#HowToBuildUNIX">How To Build And
Install On UNIX</a></h3>
<p>Building International Components for Unicode on Unix requires:</p>
<p>Building International Components for Unicode on UNIX requires:</p>
<ul>
<li>A C++ compiler installed on the target machine (for example: gcc, CC,
@ -922,8 +923,8 @@
these files may have the wrong permissions.</li>
<li>Run the <tt><a href="source/runConfigureICU">runConfigureICU</a></tt>
script for your platform. (See <a href="#HowToConfigureICU">note</a>
below).</li>
script for your platform. (See <a href="#HowToConfigureICU">configuration
note</a> below).</li>
<li>Type <tt>"gmake"</tt> (or "make" if GNU make is the default make on
your platform) to compile the libraries and all the data files. The
@ -932,12 +933,12 @@
<li>Optionally, type <tt>"gmake check"</tt> to run the test suite, which
checks for ICU's functionality integrity (See <a href=
"#HowToTestWithoutGmake">note</a> below).</li>
"#HowToTestWithoutGmake">testing note</a> below).</li>
<li>Type <tt>"gmake install"</tt> to install ICU. If you used the
--prefix= option on configure or runConfigureICU, ICU will be installed
to the directory you specified. (See <a href="#HowToInstallICU">note</a>
below).</li>
to the directory you specified. (See <a href=
"#HowToInstallICU">installation note</a> below).</li>
</ol>
<p><a name="HowToConfigureICU"><strong>Configuring ICU NOTE:</strong></a>
@ -950,21 +951,20 @@
<tt>"./configure"</tt>. 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 <a href="#ImportantNotesHPUX">note
regarding multithreaded</a> build issues with newer compilers.</p>
HP-UX user's, please see this <a href="#ImportantNotesHPUX">note regarding
multithreaded build issues</a> with newer compilers.</p>
<p><a name="HowToTestWithoutGmake"><strong>Running The Tests From The
Command Line NOTE:</strong></a> You may have to set certain variables if
you with to run test programs individually, that is apart from "gmake
check". The environment variable
<strong>ICU_DATA</strong> 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
<strong>ICU_DATA</strong> if the complete shared data library is in your
library path.</p>
check". The environment variable <strong>ICU_DATA</strong> 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 <strong>ICU_DATA</strong> if the
complete shared data library is in your library path.</p>
<p><a name="HowToInstallICU"><strong>Installing ICU NOTE:</strong></a> Some
platforms use package management tools to control the installation and
@ -992,7 +992,7 @@
<li>The gnu utilities gmake and gzip/gunzip are needed and can be
obtained for z/OS from <a href=
"http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc">
z/OS Unix - Tools and Toys</a>. Documentation on these tools can be found
z/OS UNIX - Tools and Toys</a>. Documentation on these tools can be found
at the <a href=
"http://publib-b.boulder.ibm.com/Redbooks.nsf/RedbookAbstracts/sg245944.html">
Open Source Software for z/OS UNIX</a> Red Book.</li>
@ -1007,21 +1007,22 @@
and convert all the necessary files for you automatically.</li>
<li>
<p>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.<br>
<em>Important:</em> Currently (ICU 1.4.2), native floating point
<p>z/OS supports both native S/390 hexadecimal floating point and (with
OS/390 2.6 and later) IEEE 754 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=0
will cause the z/OS version of ICU to be built without IEEE floating
point support and use the native hexadecimal floating point. By default
ICU is built with IEEE 754 support.</p>
<p><em>Important:</em> 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.</p>
UnicodeString operations, but the Format APIs require IEEE binary
floating point.</p>
<p>Examples for configuring ICU:<br>
Debug build: <code>IEEE390=1 ./runConfigureICU --enable-debug
zOS</code><br>
Release build: <code>IEEE390=1 ./runConfigureICU zOS</code></p>
Debug build: <code>./runConfigureICU --enable-debug zOS</code><br>
Release build: <code>./runConfigureICU zOS</code></p>
</li>
<li>
@ -1034,21 +1035,21 @@
prior to invoking the make process to produce binaries that are enabled
for XPLINK.</p>
<p>Note: XPLINK, enabled for z/OS 1.2 and later, requires the PTF for
<p>Note: XPLINK, which is enabled for z/OS 1.2 and later, requires the PTF
PQ69418 to build XPLINK-enabled binaries.</p>
</li>
<li>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
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.</li>
<li>The makedep executable that is used with the z/OS ICU build process
is not shipped with ICU. It is available at the <a href=
"http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc">
z/OS Unix - Tools and Toys</a> site. The PATH environment variable should
z/OS UNIX - Tools and Toys</a> 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.</li>
@ -1056,26 +1057,20 @@
<p>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
system, but you may 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.</p>
<p>To set the compiler and LE environment to OS/390 2.10, specify the
following:</p>
<pre>
<samp>./runConfigureICU OS390V2R10</samp>
</pre>
following, "<code>./runConfigureICU OS390V2R10</code>"</p>
<p>To set the compiler and LE environment to z/OS 1.2 specify the
following:</p>
<pre>
<samp>./runConfigureICU zOSV1R2</samp>
</pre>
following, "<code>./runConfigureICU zOSV1R2</code>"</p>
</li>
<li>The rest of the instructions for building and testing ICU on z/OS
with Unix System Services are the same as the <a href=
"#HowToBuildUnix">How To Build And Install On Unix</a> section.</li>
with UNIX System Services are the same as the <a href=
"#HowToBuildUNIX">How To Build And Install On UNIX</a> section.</li>
</ul>
<h4>z/OS (Batch/PDS) support outside the UNIX system services
@ -1118,7 +1113,8 @@ LOADEXP=<i>USER</i>.ICU.EXP</samp>
<p>The PDS member names for the DLL file names are as follows:</p>
<pre>
<samp>IXMI<i>XX</i>UC --&gt; libicuuc<i>XX</i>.dll
<samp>IXMI<i>XX</i>IN --&gt; libicui18n<i>XX</i>.dll
IXMI<i>XX</i>UC --&gt; libicuuc<i>XX</i>.dll
IXMI<i>XX</i>DA --&gt; libicudt<i>XX</i>e.dll
IXMI<i>XX</i>D1 --&gt; libicudt<i>XX</i>e_stub.dll <i>(Only when OS390_STUBDATA=1)</i></samp>
</pre>
@ -1179,8 +1175,8 @@ Data set name type : PDS</samp>
</ul>
<p>The following describes how to setup and build ICU. For background
information, you should look at the <a href="#HowToBuildUnix">Unix</a>
build instructions.</p>
information, you should look at the <a href="#HowToBuildUNIX">UNIX
build instructions</a>.</p>
<ol>
<li>
@ -1285,11 +1281,11 @@ del common/libicuuc.so
products. Usually only the libraries need to be considered for
packaging.</p>
<p>On Unix, you should have used "<tt>gmake install</tt>" to make it easier
<p>On UNIX, you should have used "<tt>gmake install</tt>" 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 "<tt>--prefix=</tt><i>dir</i>" configure option (See <a
href="#HowToBuildUnix">above</a>). When ICU is built on Windows, a similar
relative to the "<tt>--prefix=</tt><i>dir</i>" configure option (See the <a
href="#HowToBuildUNIX">UNIX build instructions</a>). When ICU is built on Windows, a similar
directory structure is built.</p>
<p>When changes have been made to the standard ICU distribution, it is
@ -1383,7 +1379,7 @@ del common/libicuuc.so
</tr>
<tr>
<td>Unicode stdio Library</td>
<td>ICU I/O (Unicode stdio) Library</td>
<td>icuio<i>XY</i>.dll</td>
@ -1410,11 +1406,11 @@ del common/libicuuc.so
<p>Upon the first usage of most ICU APIs, the global mutex will get
initialized properly, but you can use the <code>u_init()</code> function
from uclean.h to ensure that it is initialized properly. Without calling this
function from a single thread, the data caches inside ICU may get initialized
more than once from multiple threads, which may cause memory leaks and other
problems. There is no harm in calling <code>u_init()</code> in a single
threaded application.</p>
from uclean.h to ensure that it is initialized properly. Without calling
this function from a single thread, the data caches inside ICU may get
initialized more than once from multiple threads, which may cause memory
leaks and other problems. There is no harm in calling <code>u_init()</code>
in a single threaded application.</p>
<h4><a name="ImportantNotesHPUX" href="#ImportantNotesHPUX">Using ICU in a
Multithreaded Environment on HP-UX</a></h4>
@ -1422,11 +1418,11 @@ del common/libicuuc.so
<p>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 about the <a
href="http://docs.hp.com/hpux/onlinedocs/dev/aCC/a_03_30/options.htm#option-mt">-mt</a>
and <a
href="http://docs.hp.com/hpux/onlinedocs/dev/aCC/a_03_30/options.htm#optioncap-AA">-AA</a>
options can be found in the HP aCC documentation.</p>
to allow iostream to work properly. More information about the <a href=
"http://docs.hp.com/hpux/onlinedocs/dev/aCC/a_03_30/options.htm#option-mt">-mt</a>
and <a href=
"http://docs.hp.com/hpux/onlinedocs/dev/aCC/a_03_30/options.htm#optioncap-AA">
-AA</a> options can be found in the HP aCC documentation.</p>
<pre>
<samp>CFLAGS="-mt" CXXFLAGS="-mt -AA" LDFLAGS="-mt" ./runConfigureICU HP-UX11ACC</samp>
</pre>
@ -1443,7 +1439,7 @@ del common/libicuuc.so
source code. The same types of strings are also stored as "invariant
character" char * strings in the ICU data files.</p>
<p>ICU has hardcoded mapping tables in <code>source/common/putil.c</code>
<p>ICU has hard coded mapping tables in <code>source/common/putil.c</code>
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.</p>
@ -1705,7 +1701,7 @@ del common/libicuuc.so
will use the ANSI codepage. Note that the OEM codepage is used by default
for console window output.</li>
<li>On some Unix-type systems, non-standard names are used for encodings,
<li>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.</li>
@ -1777,10 +1773,10 @@ del common/libicuuc.so
DLLs, or search for the phrase "DLL hell" on <a href=
"http://msdn.microsoft.com/">msdn.microsoft.com</a>.</p>
<h3><a name="ImportantNotesUnix" href="#ImportantNotesUnix">Unix Type
<h3><a name="ImportantNotesUNIX" href="#ImportantNotesUNIX">UNIX Type
Platform</a></h3>
<p>If you are building on a Unix platform, and if you are installing ICU in
<p>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 <strong>LD_LIBRARY_PATH</strong> or
<strong>LIBPATH</strong> environment variable (or the equivalent runtime
@ -1813,7 +1809,7 @@ del common/libicuuc.so
This will make it easier for everyone to benefit from your work.</p>
<p>Try to follow the build steps from the <a href=
"#HowToBuildUnix">Unix</a> build instructions. If the configure script
"#HowToBuildUNIX">UNIX</a> 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:<br>
</p>
@ -1966,7 +1962,7 @@ del common/libicuuc.so
<li>pkgdata</li>
<li>makedata (a project on Windows, or source/data/Makefile on Unix)</li>
<li>makedata (a project on Windows, or source/data/Makefile on UNIX)</li>
<li>layout (optional)</li>