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