icuSources/tools/gensprep/gensprep.8.in

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