]> git.saurik.com Git - apple/icu.git/blame_incremental - icuSources/tools/gennorm/gennorm.8.in
ICU-6.2.10.tar.gz
[apple/icu.git] / icuSources / tools / gennorm / gennorm.8.in
... / ...
CommitLineData
1.\" Hey, Emacs! This is -*-nroff-*- you know...
2.\"
3.\" gennorm.8: manual page for the gennorm utility
4.\"
5.\" Copyright (C) 2000-2001 IBM, Inc. and others.
6.\"
7.TH GENNORM 8 "16 January 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
8.SH NAME
9.B gennorm
10\- compile normalization data from the Unicode Character Database
11.SH SYNOPSIS
12.B gennorm
13[
14.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
15]
16[
17.BR "\-v\fP, \fB\-\-verbose"
18]
19[
20.BI "\-u\fP, \fB\-\-unicode" " version"
21]
22[
23.BI "\-c\fP, \fB\-\-copyright"
24]
25[
26.BI "\-s\fP, \fB\-\-sourcedir" " source"
27]
28[
29.BI "\-d\fP, \fB\-\-destdir" " destination"
30]
31[
32.I suffix
33]
34.SH DESCRIPTION
35.B gennorm
36reads some of the Unicode Character Database files and compiles their
37normalization information into a binary form.
38The resulting file,
39.BR unorm.dat ,
40can then be read directly by ICU, or used by
41.BR pkgdata (8)
42for incorporation into a larger archive or library.
43.LP
44The files read by
45.B gennorm
46are described in the
47.B FILES
48section. If
49.I suffix
50is passed on the command line, the names of these files will actually
51be changed to include a dash followed by
52.I suffix
53in their basename. For example, the file
54.B UnicodeData.txt
55would be looked for under the name
56.BR UnicodeData\-\fIsuffix\fP.txt .
57.SH OPTIONS
58.TP
59.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
60Print help about usage and exit.
61.TP
62.BR "\-v\fP, \fB\-\-verbose"
63Display extra informative messages during execution.
64.TP
65.BI "\-u\fP, \fB\-\-unicode" " version"
66Specify which
67.I version
68of Unicode the Unicode Character Database refers to.
69Defaults to
70.BR 3.0.0 .
71.TP
72.BI "\-c\fP, \fB\-\-copyright"
73Include a copyright notice into the binary data.
74.TP
75.BI "\-s\fP, \fB\-\-sourcedir" " source"
76Set the source directory to
77.IR source .
78The default source directory is specified by the environment variable
79.BR ICU_DATA .
80.TP
81.BI "\-d\fP, \fB\-\-destdir" " destination"
82Set the destination directory to
83.IR destination .
84The default destination directory is specified by the environment variable
85.BR ICU_DATA .
86.SH ENVIRONMENT
87.TP 10
88.B ICU_DATA
89Specifies the directory containing ICU data. Defaults to
90.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
91Some tools in ICU depend on the presence of the trailing slash. It is thus
92important to make sure that it is present if
93.B ICU_DATA
94is set.
95.SH FILES
96The following files are read by
97.B gennorm
98and are looked for in the
99.I source
100directory.
101.TP 20
102.B UnicodeData.txt
103The main file in the Unicode Character Database. Contains character
104properties, combining classes information, decompositions, names,
105etc.\|.\|..
106.TP
107.B DerivedNormalizationProperties.txt
108Derived properties useful in dealing with normalization forms.
109.SH VERSION
110@VERSION@
111.SH COPYRIGHT
112Copyright (C) 2000-2002 IBM, Inc. and others.
113.SH SEE ALSO
114.BR pkgdata (8)