scuffed-code/icu4c/source/tools/genidna/genidna.8
Ram Viswanadha db3fff6055 ICU-2194 add man page for genidna tool
X-SVN-Rev: 11318
2003-03-14 21:40:55 +00:00

102 lines
2.4 KiB
Groff

.\" 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 2.6 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 genidna
reads filtered RFC 3454 files and compiles their
information into a binary form.
The resulting file,
.BR uidna.icu ,
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 genidna
are described in the
.B FILES
section.
.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 "\-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 NONE/lib/icu/2.6/ .
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 genidna
and are looked for in the
.I source
directory.
.TP 20
.B rfc3453_A_1.txt
Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..
.TP
.B rfc3454_B_1.txt
Contains the list of code points that are commonly mapped to nothing.\|.\|..
.B rfc3454_B_2.txt
Contains the list of mappings for casefolding of code points when Normalization form NFKC is specified.\|.\|..
.B rfc3454_C_X.txt
Contains the list of code points that are prohibited for IDNA.
.SH VERSION
2.6
.SH COPYRIGHT
Copyright (C) 2000-2002 IBM, Inc. and others.
.SH SEE ALSO
.BR pkgdata (8)