|
jpayne@68
|
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
|
|
jpayne@68
|
2 .\"
|
|
jpayne@68
|
3 .\" genbrk.1: manual page for the genbrk utility
|
|
jpayne@68
|
4 .\"
|
|
jpayne@68
|
5 .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
|
|
jpayne@68
|
6 .\" License & terms of use: http://www.unicode.org/copyright.html
|
|
jpayne@68
|
7 .\" Copyright (C) 2005-2006 International Business Machines Corporation and others
|
|
jpayne@68
|
8 .\"
|
|
jpayne@68
|
9 .TH GENBRK 1 "2 December 2005" "ICU MANPAGE" "ICU 67.1 Manual"
|
|
jpayne@68
|
10 .SH NAME
|
|
jpayne@68
|
11 .B genbrk
|
|
jpayne@68
|
12 \- Compiles ICU break iteration rules source files into binary data files
|
|
jpayne@68
|
13 .SH SYNOPSIS
|
|
jpayne@68
|
14 .B genbrk
|
|
jpayne@68
|
15 [
|
|
jpayne@68
|
16 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
|
jpayne@68
|
17 ]
|
|
jpayne@68
|
18 [
|
|
jpayne@68
|
19 .BR "\-V\fP, \fB\-\-version"
|
|
jpayne@68
|
20 ]
|
|
jpayne@68
|
21 [
|
|
jpayne@68
|
22 .BR "\-c\fP, \fB\-\-copyright"
|
|
jpayne@68
|
23 ]
|
|
jpayne@68
|
24 [
|
|
jpayne@68
|
25 .BR "\-v\fP, \fB\-\-verbose"
|
|
jpayne@68
|
26 ]
|
|
jpayne@68
|
27 [
|
|
jpayne@68
|
28 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
|
jpayne@68
|
29 ]
|
|
jpayne@68
|
30 [
|
|
jpayne@68
|
31 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
|
jpayne@68
|
32 ]
|
|
jpayne@68
|
33 .BI "\-r\fP, \fB\-\-rules" " rule\-file"
|
|
jpayne@68
|
34 .BI "\-o\fP, \fB\-\-out" " output\-file"
|
|
jpayne@68
|
35 .SH DESCRIPTION
|
|
jpayne@68
|
36 .B genbrk
|
|
jpayne@68
|
37 reads the break (boundary) rule source code from
|
|
jpayne@68
|
38 .I rule-file
|
|
jpayne@68
|
39 and creates a break iteration data file. Normally this data file has the
|
|
jpayne@68
|
40 .B .brk
|
|
jpayne@68
|
41 extension.
|
|
jpayne@68
|
42 .PP
|
|
jpayne@68
|
43 The details of the rule syntax can be found in ICU's User Guide.
|
|
jpayne@68
|
44 .SH OPTIONS
|
|
jpayne@68
|
45 .TP
|
|
jpayne@68
|
46 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
|
jpayne@68
|
47 Print help about usage and exit.
|
|
jpayne@68
|
48 .TP
|
|
jpayne@68
|
49 .BR "\-V\fP, \fB\-\-version"
|
|
jpayne@68
|
50 Print the version of
|
|
jpayne@68
|
51 .B genbrk
|
|
jpayne@68
|
52 and exit.
|
|
jpayne@68
|
53 .TP
|
|
jpayne@68
|
54 .BR "\-c\fP, \fB\-\-copyright"
|
|
jpayne@68
|
55 Embeds the standard ICU copyright into the
|
|
jpayne@68
|
56 .IR output-file .
|
|
jpayne@68
|
57 .TP
|
|
jpayne@68
|
58 .BR "\-v\fP, \fB\-\-verbose"
|
|
jpayne@68
|
59 Display extra informative messages during execution.
|
|
jpayne@68
|
60 .TP
|
|
jpayne@68
|
61 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
|
jpayne@68
|
62 Set the destination directory of the
|
|
jpayne@68
|
63 .IR output-file
|
|
jpayne@68
|
64 to
|
|
jpayne@68
|
65 .IR destination .
|
|
jpayne@68
|
66 .TP
|
|
jpayne@68
|
67 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
|
jpayne@68
|
68 Look for any necessary ICU data files in
|
|
jpayne@68
|
69 .IR directory .
|
|
jpayne@68
|
70 For example, the file
|
|
jpayne@68
|
71 .B pnames.icu
|
|
jpayne@68
|
72 must be located when ICU's data is not built as a shared library.
|
|
jpayne@68
|
73 The default ICU data directory is specified by the environment variable
|
|
jpayne@68
|
74 .BR ICU_DATA .
|
|
jpayne@68
|
75 Most configurations of ICU do not require this argument.
|
|
jpayne@68
|
76 .TP
|
|
jpayne@68
|
77 .BI "\-r\fP, \fB\-\-rules" " rule\-file"
|
|
jpayne@68
|
78 The source file to read.
|
|
jpayne@68
|
79 .TP
|
|
jpayne@68
|
80 .BI "\-o\fP, \fB\-\-out" " output\-file"
|
|
jpayne@68
|
81 The output data file to write.
|
|
jpayne@68
|
82 .SH CAVEATS
|
|
jpayne@68
|
83 When the
|
|
jpayne@68
|
84 .IR rule-file
|
|
jpayne@68
|
85 contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character
|
|
jpayne@68
|
86 .B U+FEFF,
|
|
jpayne@68
|
87 then the
|
|
jpayne@68
|
88 .IR rule-file
|
|
jpayne@68
|
89 is interpreted as Unicode. Without the BOM,
|
|
jpayne@68
|
90 the file is interpreted in the current operating system default codepage.
|
|
jpayne@68
|
91 In order to eliminate any ambiguity of the encoding for how the
|
|
jpayne@68
|
92 .IR rule-file
|
|
jpayne@68
|
93 was written, it is recommended that you write this file in UTF-8
|
|
jpayne@68
|
94 with the BOM.
|
|
jpayne@68
|
95 .SH ENVIRONMENT
|
|
jpayne@68
|
96 .TP 10
|
|
jpayne@68
|
97 .B ICU_DATA
|
|
jpayne@68
|
98 Specifies the directory containing ICU data. Defaults to
|
|
jpayne@68
|
99 .BR ${prefix}/share/icu/67.1/ .
|
|
jpayne@68
|
100 Some tools in ICU depend on the presence of the trailing slash. It is thus
|
|
jpayne@68
|
101 important to make sure that it is present if
|
|
jpayne@68
|
102 .B ICU_DATA
|
|
jpayne@68
|
103 is set.
|
|
jpayne@68
|
104 .SH AUTHORS
|
|
jpayne@68
|
105 George Rhoten
|
|
jpayne@68
|
106 .br
|
|
jpayne@68
|
107 Andy Heninger
|
|
jpayne@68
|
108 .SH VERSION
|
|
jpayne@68
|
109 1.0
|
|
jpayne@68
|
110 .SH COPYRIGHT
|
|
jpayne@68
|
111 Copyright (C) 2005 International Business Machines Corporation and others
|
|
jpayne@68
|
112 .SH SEE ALSO
|
|
jpayne@68
|
113 .BR http://www.icu-project.org/userguide/boundaryAnalysis.html
|
|
jpayne@68
|
114
|
