icuSources/tools/genprops/genprops.8.in

   1 .\" Hey, Emacs! This is -*-nroff-*- you know...
   2 .\"
   3 .\" genprops.8: manual page for the genprops utility
   4 .\"
   5 .\" Copyright (C) 2000-2001 IBM, Inc. and others.
   6 .\"
   7 .TH GENPROPS 8 "16 January 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
   8 .SH NAME
   9 .B genprops
  10 \- compile properties from the Unicode Character Database
  11 .SH SYNOPSIS
  12 .B genprops
  13 [
  14 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  15 ]
  16 [
  17 .BR "\-v\fP, \fB\-\-verbose"
  18 ]
  19 [
  20 .BI "\-u\fP, \fB\-\-unicode" " version"
  21 ]
  22 [
  23 .BI "\-c\fP, \fB\-\-copyright"
  24 ]
  25 [
  26 .BI "\-s\fP, \fB\-\-sourcedir" " source"
  27 ]
  28 [
  29 .BI "\-d\fP, \fB\-\-destdir" " destination"
  30 ]
  31 [
  32 .I suffix
  33 ]
  34 .SH DESCRIPTION
  35 .B genprops
  36 reads some of the Unicode Character Database files and compiles their
  37 information information into a binary form.
  38 The resulting file,
  39 .BR icudata.dat ,
  40 can then be read directly by ICU, or used by
  41 .BR pkgdata (8)
  42 for incorporation into a larger archive or library.
  43 .LP
  44 The files read by
  45 .B genprops
  46 are described in the
  47 .B FILES
  48 section. If
  49 .I suffix
  50 is passed on the command line, the names of these files will actually
  51 be changed to include a dash followed by
  52 .I suffix
  53 in their basename. For example, the file
  54 .B UnicodeData.txt
  55 would be looked for under the name
  56 .BR UnicodeData\-\fIsuffix\fP.txt .
  57 .SH OPTIONS
  58 .TP
  59 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  60 Print help about usage and exit.
  61 .TP
  62 .BR "\-v\fP, \fB\-\-verbose"
  63 Display extra informative messages during execution.
  64 .TP
  65 .BI "\-u\fP, \fB\-\-unicode" " version"
  66 Specify which
  67 .I version
  68 of Unicode the Unicode Character Database refers to.
  69 Defaults to
  70 .BR 3.0.0 .
  71 .TP
  72 .BI "\-c\fP, \fB\-\-copyright"
  73 Include a copyright notice into the binary data.
  74 .TP
  75 .BI "\-s\fP, \fB\-\-sourcedir" " source"
  76 Set the source directory to
  77 .IR source .
  78 The default source directory is specified by the environment variable
  79 .BR ICU_DATA .
  80 .TP
  81 .BI "\-d\fP, \fB\-\-destdir" " destination"
  82 Set the destination directory to
  83 .IR destination .
  84 The default destination directory is specified by the environment variable
  85 .BR ICU_DATA .
  86 .SH ENVIRONMENT
  87 .TP 10
  88 .B ICU_DATA
  89 Specifies the directory containing ICU data. Defaults to
  90 .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
  91 Some tools in ICU depend on the presence of the trailing slash. It is thus
  92 important to make sure that it is present if
  93 .B ICU_DATA
  94 is set.
  95 .SH FILES
  96 The following files are read by
  97 .B genprops
  98 and are looked for in the
  99 .I source
 100 directory.
 101 .TP 20
 102 .B UnicodeData.txt
 103 The main file in the Unicode Character Database. Contains character
 104 properties, combining classes information, decompositions, names,
 105 etc.\|.\|..
 106 .TP
 107 .B BidiMirroring.txt
 108 Properties for substituting characters in an implementation of
 109 bidirectional mirroring.
 110 .TP
 111 .B SpecialCasing.txt
 112 List of properties required for full case mapping.
 113 .TP
 114 .B CaseFolding.txt
 115 Mapping from characters to their case-folded forms. (Note: this file
 116 is derived from
 117 .B UnicodeData.txt
 118 and
 119 .B SpecialCasing.txt
 120 when generated by the Unicode Consortium.)
 121 .SH VERSION
 122 @VERSION@
 123 .SH COPYRIGHT
 124 Copyright (C) 2000-2002 IBM, Inc. and others.
 125 .SH SEE ALSO
 126 .BR pkgdata (8)