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