]> git.saurik.com Git - apple/icu.git/blame - icuSources/tools/gensprep/gensprep.8.in
ICU-531.48.tar.gz
[apple/icu.git] / icuSources / tools / gensprep / gensprep.8.in
CommitLineData
b75a7d8f
A
1.\" Hey, Emacs! This is -*-nroff-*- you know...
2.\"
374ca955 3.\" gensprep.8: manual page for the gensprep utility
b75a7d8f
A
4.\"
5.\" Copyright (C) 2003 IBM, Inc. and others.
6.\"
374ca955 7.TH gensprep 8 "18 March 2003" "ICU MANPAGE" "ICU @VERSION@ Manual"
b75a7d8f 8.SH NAME
374ca955
A
9.B gensprep
10\- compile StringPrep data from files filtered by filterRFC3454.pl
b75a7d8f 11.SH SYNOPSIS
374ca955 12.B gensprep
b75a7d8f
A
13[
14.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
15]
16[
17.BR "\-v\fP, \fB\-\-verbose"
18]
19[
20.BI "\-c\fP, \fB\-\-copyright"
21]
22[
23.BI "\-s\fP, \fB\-\-sourcedir" " source"
24]
25[
26.BI "\-d\fP, \fB\-\-destdir" " destination"
27]
28.SH DESCRIPTION
374ca955 29.B gensprep
b75a7d8f
A
30reads filtered RFC 3454 files and compiles their
31information into a binary form.
32The resulting file,
374ca955 33.BR <name>.icu ,
b75a7d8f
A
34can then be read directly by ICU, or used by
35.BR pkgdata (8)
36for incorporation into a larger archive or library.
37.LP
38The files read by
374ca955 39.B gensprep
b75a7d8f
A
40are described in the
41.B FILES
42section.
43.SH OPTIONS
44.TP
45.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
46Print help about usage and exit.
47.TP
48.BR "\-v\fP, \fB\-\-verbose"
49Display extra informative messages during execution.
50.TP
51.BI "\-c\fP, \fB\-\-copyright"
52Include a copyright notice into the binary data.
53.TP
54.BI "\-s\fP, \fB\-\-sourcedir" " source"
55Set the source directory to
56.IR source .
57The default source directory is specified by the environment variable
58.BR ICU_DATA .
59.TP
60.BI "\-d\fP, \fB\-\-destdir" " destination"
61Set the destination directory to
62.IR destination .
63The default destination directory is specified by the environment variable
64.BR ICU_DATA .
65.SH ENVIRONMENT
66.TP 10
67.B ICU_DATA
68Specifies the directory containing ICU data. Defaults to
69.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
70Some tools in ICU depend on the presence of the trailing slash. It is thus
71important to make sure that it is present if
72.B ICU_DATA
73is set.
74.SH FILES
75The following files are read by
374ca955 76.B gensprep
b75a7d8f
A
77and are looked for in the
78.I source
79/misc for rfc3454_*.txt files and in
80.I source
81/unidata for NormalizationCorrections.txt.
82.TP 20
83.B rfc3453_A_1.txt
84Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..
85.TP
86.B rfc3454_B_1.txt
87Contains the list of code points that are commonly mapped to nothing.\|.\|..
88.TP
89.B rfc3454_B_2.txt
90Contains the list of mappings for casefolding of code points when Normalization form NFKC is specified.\|.\|..
91.TP
92.B rfc3454_C_X.txt
93Contains the list of code points that are prohibited for IDNA.
94.TP
95.B NormalizationCorrections.txt
96Contains the list of code points whose normalization has changed since Unicode Version 3.2.0.
97.SH VERSION
98@VERSION@
99.SH COPYRIGHT
100Copyright (C) 2000-2002 IBM, Inc. and others.
101.SH SEE ALSO
102.BR pkgdata (8)