git.saurik.com Git - apple/icu.git/blame_incremental - icuSources/tools/gencase/gencase.8.in

... / ...

Commit	Line	Data
	1	.\" Hey, Emacs! This is --nroff-- you know...
	2	.\"
	3	.\" gencase.8: manual page for the gencase utility
	4	.\"
	5	.\" Copyright (C) 2004 IBM, Inc. and others.
	6	.\"
	7	.TH GENCASE 8 "16 September 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
	8	.SH NAME
	9	.B gencase
	10	\- compile case mapping properties from the Unicode Character Database
	11	.SH SYNOPSIS
	12	.B gencase
	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	.BI "\-i\fP, \fB\-\-icudatadir" " path"
	33	]
	34	[
	35	.I suffix
	36	]
	37	.SH DESCRIPTION
	38	.B gencase
	39	reads some of the Unicode Character Database files and compiles their
	40	information information into a binary form.
	41	The resulting file,
	42	.BR ucase.icu ,
	43	can then be read directly by ICU, or used by
	44	.BR pkgdata (8)
	45	for incorporation into a larger archive or library.
	46	.LP
	47	The files read by
	48	.B gencase
	49	are described in the
	50	.B FILES
	51	section. If
	52	.I suffix
	53	is passed on the command line, the names of these files will actually
	54	be changed to include a dash followed by
	55	.I suffix
	56	in their basename. For example, the file
	57	.B UnicodeData.txt
	58	would be looked for under the name
	59	.BR UnicodeData\-\fIsuffix\fP.txt .
	60	.SH OPTIONS
	61	.TP
	62	.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
	63	Print help about usage and exit.
	64	.TP
	65	.BR "\-v\fP, \fB\-\-verbose"
	66	Display extra informative messages during execution.
	67	.TP
	68	.BI "\-u\fP, \fB\-\-unicode" " version"
	69	Specify which
	70	.I version
	71	of Unicode the Unicode Character Database refers to.
	72	Defaults to
	73	.BR 3.0.0 .
	74	.TP
	75	.BI "\-c\fP, \fB\-\-copyright"
	76	Include a copyright notice into the binary data.
	77	.TP
	78	.BI "\-s\fP, \fB\-\-sourcedir" " source"
	79	Set the source directory to
	80	.IR source .
	81	The default source directory is the current working directory.
	82	.TP
	83	.BI "\-d\fP, \fB\-\-destdir" " destination"
	84	Set the destination directory to
	85	.IR destination .
	86	The default destination directory is specified by the environment variable
	87	.BR ICU_DATA .
	88	.TP
	89	.BI "\-i\fP, \fB\-\-icudatadir" " path"
	90	Set the directory for loading ICU data files to
	91	.IR path .
	92	The default ICU data directory is specified by the environment variable
	93	.BR ICU_DATA .
	94	.SH ENVIRONMENT
	95	.TP 10
	96	.B ICU_DATA
	97	Specifies the directory containing ICU data. Defaults to
	98	.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
	99	Some tools in ICU depend on the presence of the trailing slash. It is thus
	100	important to make sure that it is present if
	101	.B ICU_DATA
	102	is set.
	103	.SH FILES
	104	The following files are read by
	105	.B gencase
	106	and are looked for in the
	107	.I source
	108	directory.
	109	.TP 20
	110	.B UnicodeData.txt
	111	The main file in the Unicode Character Database. Contains character
	112	properties, combining classes information, decompositions, names,
	113	etc.\\|.\\|..
	114	.TP
	115	.B PropList.txt
	116	Listing of auxiliary binary character properties.
	117	.TP
	118	.B DerivedCoreProperties.txt
	119	Derived binary properties, generated by Unicode from other files.
	120	.TP
	121	.B SpecialCasing.txt
	122	List of properties required for full case mapping.
	123	.TP
	124	.B CaseFolding.txt
	125	Mapping from characters to their case-folded forms. (Note: this file
	126	is derived from
	127	.B UnicodeData.txt
	128	and
	129	.B SpecialCasing.txt
	130	when generated by the Unicode Consortium.)
	131	.SH VERSION
	132	@VERSION@
	133	.SH COPYRIGHT
	134	Copyright (C) 2004 IBM, Inc. and others.
	135	.SH SEE ALSO
	136	.BR pkgdata (8)