[apple/icu.git] / icuSources / tools / gennorm / gennorm.8.in

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