git.saurik.com Git - apple/icu.git/blob - 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 .\"

6 .\" License & terms of use: http://www.unicode.org/copyright.html

8 .\"

9 .TH gensprep 8 "18 March 2003" "ICU MANPAGE" "ICU @VERSION@ Manual"

10 .SH NAME

11 .B gensprep

12 \- compile StringPrep data from files filtered by filterRFC3454.pl

13 .SH SYNOPSIS

14 .B gensprep

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

31 .B gensprep

32 reads filtered RFC 3454 files and compiles their

33 information into a binary form.

34 The resulting file,

35 .BR <name>.icu ,

36 can then be read directly by ICU, or used by

37 .BR pkgdata (8)

38 for incorporation into a larger archive or library.

39 .LP

40 The files read by

41 .B gensprep

42 are described in the

43 .B FILES

44 section.

45 .SH OPTIONS

46 .TP

47 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"

48 Print help about usage and exit.

49 .TP

50 .BR "\-v\fP, \fB\-\-verbose"

51 Display extra informative messages during execution.

52 .TP

53 .BI "\-c\fP, \fB\-\-copyright"

54 Include a copyright notice into the binary data.

55 .TP

56 .BI "\-s\fP, \fB\-\-sourcedir" " source"

57 Set the source directory to

58 .IR source .

59 The default source directory is specified by the environment variable

60 .BR ICU_DATA .

61 .TP

62 .BI "\-d\fP, \fB\-\-destdir" " destination"

63 Set the destination directory to

64 .IR destination .

65 The default destination directory is specified by the environment variable

66 .BR ICU_DATA .

67 .SH ENVIRONMENT

68 .TP 10

69 .B ICU_DATA

70 Specifies the directory containing ICU data. Defaults to

71 .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .

72 Some tools in ICU depend on the presence of the trailing slash. It is thus

73 important to make sure that it is present if

74 .B ICU_DATA

75 is set.

76 .SH FILES

77 The following files are read by

78 .B gensprep

79 and 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

86 Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..

87 .TP

88 .B rfc3454_B_1.txt

89 Contains the list of code points that are commonly mapped to nothing.\|.\|..

90 .TP

91 .B rfc3454_B_2.txt

92 Contains the list of mappings for casefolding of code points when Normalization form NFKC is specified.\|.\|..

93 .TP

94 .B rfc3454_C_X.txt

95 Contains the list of code points that are prohibited for IDNA.

96 .TP

97 .B NormalizationCorrections.txt

98 Contains the list of code points whose normalization has changed since Unicode Version 3.2.0.

99 .SH VERSION

100 @VERSION@

101 .SH COPYRIGHT

103 .SH SEE ALSO

104 .BR pkgdata (8)