git.saurik.com Git - apple/icu.git/blob - icuSources/tools/genbrk/genbrk.1.in

1 .\" Hey, Emacs! This is -*-nroff-*- you know...

2 .\"

3 .\" genbrk.1: manual page for the genbrk utility

4 .\"

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

8 .\"

9 .TH GENBRK 1 "2 December 2005" "ICU MANPAGE" "ICU @VERSION@ Manual"

10 .SH NAME

11 .B genbrk

12 \- Compiles ICU break iteration rules source files into binary data files

13 .SH SYNOPSIS

14 .B genbrk

15 [

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

17 ]

18 [

19 .BR "\-V\fP, \fB\-\-version"

20 ]

21 [

22 .BR "\-c\fP, \fB\-\-copyright"

23 ]

24 [

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

26 ]

27 [

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

29 ]

30 [

31 .BI "\-i\fP, \fB\-\-icudatadir" " directory"

32 ]

33 .BI "\-r\fP, \fB\-\-rules" " rule\-file"

34 .BI "\-o\fP, \fB\-\-out" " output\-file"

35 .SH DESCRIPTION

36 .B genbrk

37 reads the break (boundary) rule source code from

38 .I rule-file

39 and creates a break iteration data file. Normally this data file has the

40 .B .brk

41 extension.

42 .PP

43 The details of the rule syntax can be found in ICU's User Guide.

44 .SH OPTIONS

45 .TP

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

47 Print help about usage and exit.

48 .TP

49 .BR "\-V\fP, \fB\-\-version"

50 Print the version of

51 .B genbrk

52 and exit.

53 .TP

54 .BR "\-c\fP, \fB\-\-copyright"

55 Embeds the standard ICU copyright into the

56 .IR output-file .

57 .TP

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

59 Display extra informative messages during execution.

60 .TP

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

62 Set the destination directory of the

63 .IR output-file

64 to

65 .IR destination .

66 .TP

67 .BI "\-i\fP, \fB\-\-icudatadir" " directory"

68 Look for any necessary ICU data files in

69 .IR directory .

70 For example, the file

71 .B pnames.icu

72 must be located when ICU's data is not built as a shared library.

73 The default ICU data directory is specified by the environment variable

74 .BR ICU_DATA .

75 Most configurations of ICU do not require this argument.

76 .TP

77 .BI "\-r\fP, \fB\-\-rules" " rule\-file"

78 The source file to read.

79 .TP

80 .BI "\-o\fP, \fB\-\-out" " output\-file"

81 The output data file to write.

82 .SH CAVEATS

83 When the

84 .IR rule-file

85 contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character

86 .B U+FEFF,

87 then the

88 .IR rule-file

89 is interpreted as Unicode. Without the BOM,

90 the file is interpreted in the current operating system default codepage.

91 In order to eliminate any ambiguity of the encoding for how the

92 .IR rule-file

93 was written, it is recommended that you write this file in UTF-8

94 with the BOM.

95 .SH ENVIRONMENT

96 .TP 10

97 .B ICU_DATA

98 Specifies the directory containing ICU data. Defaults to

99 .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .

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

101 important to make sure that it is present if

102 .B ICU_DATA

103 is set.

104 .SH AUTHORS

105 George Rhoten

106 .br

107 Andy Heninger

108 .SH VERSION

109 1.0

110 .SH COPYRIGHT

112 .SH SEE ALSO

113 .BR http://www.icu-project.org/userguide/boundaryAnalysis.html

114