1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/gensprep/gensprep.8.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,102 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" gensprep.8: manual page for the gensprep utility
1.7 +.\"
1.8 +.\" Copyright (C) 2003 IBM, Inc. and others.
1.9 +.\"
1.10 +.TH gensprep 8 "18 March 2003" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.11 +.SH NAME
1.12 +.B gensprep
1.13 +\- compile StringPrep data from files filtered by filterRFC3454.pl
1.14 +.SH SYNOPSIS
1.15 +.B gensprep
1.16 +[
1.17 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.18 +]
1.19 +[
1.20 +.BR "\-v\fP, \fB\-\-verbose"
1.21 +]
1.22 +[
1.23 +.BI "\-c\fP, \fB\-\-copyright"
1.24 +]
1.25 +[
1.26 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.27 +]
1.28 +[
1.29 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.30 +]
1.31 +.SH DESCRIPTION
1.32 +.B gensprep
1.33 +reads filtered RFC 3454 files and compiles their
1.34 +information into a binary form.
1.35 +The resulting file,
1.36 +.BR <name>.icu ,
1.37 +can then be read directly by ICU, or used by
1.38 +.BR pkgdata (8)
1.39 +for incorporation into a larger archive or library.
1.40 +.LP
1.41 +The files read by
1.42 +.B gensprep
1.43 +are described in the
1.44 +.B FILES
1.45 +section.
1.46 +.SH OPTIONS
1.47 +.TP
1.48 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.49 +Print help about usage and exit.
1.50 +.TP
1.51 +.BR "\-v\fP, \fB\-\-verbose"
1.52 +Display extra informative messages during execution.
1.53 +.TP
1.54 +.BI "\-c\fP, \fB\-\-copyright"
1.55 +Include a copyright notice into the binary data.
1.56 +.TP
1.57 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.58 +Set the source directory to
1.59 +.IR source .
1.60 +The default source directory is specified by the environment variable
1.61 +.BR ICU_DATA .
1.62 +.TP
1.63 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.64 +Set the destination directory to
1.65 +.IR destination .
1.66 +The default destination directory is specified by the environment variable
1.67 +.BR ICU_DATA .
1.68 +.SH ENVIRONMENT
1.69 +.TP 10
1.70 +.B ICU_DATA
1.71 +Specifies the directory containing ICU data. Defaults to
1.72 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.73 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.74 +important to make sure that it is present if
1.75 +.B ICU_DATA
1.76 +is set.
1.77 +.SH FILES
1.78 +The following files are read by
1.79 +.B gensprep
1.80 +and are looked for in the
1.81 +.I source
1.82 +/misc for rfc3454_*.txt files and in
1.83 +.I source
1.84 +/unidata for NormalizationCorrections.txt.
1.85 +.TP 20
1.86 +.B rfc3453_A_1.txt
1.87 +Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..
1.88 +.TP
1.89 +.B rfc3454_B_1.txt
1.90 +Contains the list of code points that are commonly mapped to nothing.\|.\|..
1.91 +.TP
1.92 +.B rfc3454_B_2.txt
1.93 +Contains the list of mappings for casefolding of code points when Normalization form NFKC is specified.\|.\|..
1.94 +.TP
1.95 +.B rfc3454_C_X.txt
1.96 +Contains the list of code points that are prohibited for IDNA.
1.97 +.TP
1.98 +.B NormalizationCorrections.txt
1.99 +Contains the list of code points whose normalization has changed since Unicode Version 3.2.0.
1.100 +.SH VERSION
1.101 +@VERSION@
1.102 +.SH COPYRIGHT
1.103 +Copyright (C) 2000-2002 IBM, Inc. and others.
1.104 +.SH SEE ALSO
1.105 +.BR pkgdata (8)
