jpayne@68
|
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
|
jpayne@68
|
2 .\"
|
jpayne@68
|
3 .\" genrb.1: manual page for the genrb 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) 2000-2002 IBM, Inc. and others.
|
jpayne@68
|
8 .\"
|
jpayne@68
|
9 .\" Manual page by Yves Arrouye <yves@realnames.com>.
|
jpayne@68
|
10 .\"
|
jpayne@68
|
11 .TH GENRB 1 "16 April 2002" "ICU MANPAGE" "ICU 67.1 Manual"
|
jpayne@68
|
12 .SH NAME
|
jpayne@68
|
13 .B genrb
|
jpayne@68
|
14 \- compile a resource bundle
|
jpayne@68
|
15 .SH SYNOPSIS
|
jpayne@68
|
16 .B genrb
|
jpayne@68
|
17 [
|
jpayne@68
|
18 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
jpayne@68
|
19 ]
|
jpayne@68
|
20 [
|
jpayne@68
|
21 .BR "\-V\fP, \fB\-\-version"
|
jpayne@68
|
22 ]
|
jpayne@68
|
23 [
|
jpayne@68
|
24 .BR "\-v\fP, \fB\-\-verbose"
|
jpayne@68
|
25 ]
|
jpayne@68
|
26 [
|
jpayne@68
|
27 .BI "\-e\fP, \fB\-\-encoding" " encoding"
|
jpayne@68
|
28 ]
|
jpayne@68
|
29 [
|
jpayne@68
|
30 .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
|
jpayne@68
|
31 ]
|
jpayne@68
|
32 [
|
jpayne@68
|
33 .BI "\-s\fP, \fB\-\-sourcedir" " source"
|
jpayne@68
|
34 ]
|
jpayne@68
|
35 [
|
jpayne@68
|
36 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
jpayne@68
|
37 ]
|
jpayne@68
|
38 [
|
jpayne@68
|
39 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
jpayne@68
|
40 ]
|
jpayne@68
|
41 .IR bundle " \.\.\."
|
jpayne@68
|
42 .SH DESCRIPTION
|
jpayne@68
|
43 .B genrb
|
jpayne@68
|
44 converts the resource
|
jpayne@68
|
45 .I bundle
|
jpayne@68
|
46 source files passed on the command line to their binary form or to
|
jpayne@68
|
47 a Java source file for use with ICU4J.
|
jpayne@68
|
48 The resulting binary files have a
|
jpayne@68
|
49 .B .res
|
jpayne@68
|
50 extension while resource bundle source files typically have a
|
jpayne@68
|
51 .B .txt
|
jpayne@68
|
52 extension. Java source files have a
|
jpayne@68
|
53 .B java
|
jpayne@68
|
54 extension and follow the ICU4J naming conventions.
|
jpayne@68
|
55 .PP
|
jpayne@68
|
56 It is customary to name the resource bundles by their locale name,
|
jpayne@68
|
57 i.e. to use a local identifier for the
|
jpayne@68
|
58 .I bundle
|
jpayne@68
|
59 filename, e.g.
|
jpayne@68
|
60 .B ja_JP.txt
|
jpayne@68
|
61 for Japanese (Japan) data, or
|
jpayne@68
|
62 .B root.txt
|
jpayne@68
|
63 for the root bundle.
|
jpayne@68
|
64 In any case,
|
jpayne@68
|
65 .B genrb
|
jpayne@68
|
66 will produce a file whose base name is the name of the locale found
|
jpayne@68
|
67 in the resource file, not the base name of the resource file itself.
|
jpayne@68
|
68 .PP
|
jpayne@68
|
69 The binary files can be read directly by ICU, or used by
|
jpayne@68
|
70 .BR pkgdata (1)
|
jpayne@68
|
71 for incorporation into a larger archive or library.
|
jpayne@68
|
72 .SH OPTIONS
|
jpayne@68
|
73 .TP
|
jpayne@68
|
74 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
jpayne@68
|
75 Print help about usage and exit.
|
jpayne@68
|
76 .TP
|
jpayne@68
|
77 .BR "\-V\fP, \fB\-\-version"
|
jpayne@68
|
78 Print the version of
|
jpayne@68
|
79 .B genrb
|
jpayne@68
|
80 and exit.
|
jpayne@68
|
81 .TP
|
jpayne@68
|
82 .BR "\-v\fP, \fB\-\-verbose"
|
jpayne@68
|
83 Display extra informative messages during execution.
|
jpayne@68
|
84 .TP
|
jpayne@68
|
85 .BI "\-e\fP, \fB\-\-encoding" " encoding"
|
jpayne@68
|
86 Set the encoding used to read input files to
|
jpayne@68
|
87 .IR encoding .
|
jpayne@68
|
88 The default encoding is the invariant (subset of ASCII or EBCDIC)
|
jpayne@68
|
89 codepage for the system (see section
|
jpayne@68
|
90 .BR "INVARIANT CHARACTERS" ).
|
jpayne@68
|
91 The encodings UTF-8, UTF-16BE, and UTF-16LE are automatically detected
|
jpayne@68
|
92 if a byte order mark (BOM) is present.
|
jpayne@68
|
93 .TP
|
jpayne@68
|
94 .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
|
jpayne@68
|
95 Generate a Java source code for use with ICU4J. An optional
|
jpayne@68
|
96 .I encoding
|
jpayne@68
|
97 for the Java file can be given.
|
jpayne@68
|
98 .TP
|
jpayne@68
|
99 .BI "\-s\fP, \fB\-\-sourcedir" " source"
|
jpayne@68
|
100 Set the source directory to
|
jpayne@68
|
101 .IR source .
|
jpayne@68
|
102 The default source directory is specified by the environment variable
|
jpayne@68
|
103 .BR ICU_DATA ,
|
jpayne@68
|
104 or the location set when ICU was built if
|
jpayne@68
|
105 .B ICU_DATA
|
jpayne@68
|
106 is not set.
|
jpayne@68
|
107 .TP
|
jpayne@68
|
108 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
jpayne@68
|
109 Set the destination directory to
|
jpayne@68
|
110 .IR destination .
|
jpayne@68
|
111 The default destination directory is specified by the environment variable
|
jpayne@68
|
112 .BR ICU_DATA
|
jpayne@68
|
113 or is the location set when ICU was built if
|
jpayne@68
|
114 .B ICU_DATA
|
jpayne@68
|
115 is not set.
|
jpayne@68
|
116 .TP
|
jpayne@68
|
117 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
jpayne@68
|
118 Look for any necessary ICU data files in
|
jpayne@68
|
119 .IR directory .
|
jpayne@68
|
120 For example, when processing collation overrides, the file
|
jpayne@68
|
121 .B ucadata.dat
|
jpayne@68
|
122 must be located.
|
jpayne@68
|
123 The default ICU data directory is specified by the environment variable
|
jpayne@68
|
124 .BR ICU_DATA .
|
jpayne@68
|
125 .SH INVARIANT CHARACTERS
|
jpayne@68
|
126 The
|
jpayne@68
|
127 .B invariant character set
|
jpayne@68
|
128 consists of the following set of characters, expressed as a standard POSIX
|
jpayne@68
|
129 regular expression:
|
jpayne@68
|
130 .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
|
jpayne@68
|
131 This is the set which is guaranteed to be available regardless of code page.
|
jpayne@68
|
132 .SH ENVIRONMENT
|
jpayne@68
|
133 .TP 10
|
jpayne@68
|
134 .B ICU_DATA
|
jpayne@68
|
135 Specifies the directory containing ICU data. Defaults to
|
jpayne@68
|
136 .BR ${prefix}/share/icu/67.1/ .
|
jpayne@68
|
137 Some tools in ICU depend on the presence of the trailing slash. It is thus
|
jpayne@68
|
138 important to make sure that it is present if
|
jpayne@68
|
139 .B ICU_DATA
|
jpayne@68
|
140 is set.
|
jpayne@68
|
141 .SH VERSION
|
jpayne@68
|
142 67.1
|
jpayne@68
|
143 .SH COPYRIGHT
|
jpayne@68
|
144 Copyright (C) 2000-2002 IBM, Inc. and others.
|
jpayne@68
|
145 .SH SEE ALSO
|
jpayne@68
|
146 .BR derb (1)
|
jpayne@68
|
147 .br
|
jpayne@68
|
148 .BR pkgdata (1)
|