jpayne@68
|
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
|
jpayne@68
|
2 .\"
|
jpayne@68
|
3 .\" derb.1: manual page for the derb 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-2014 IBM, Inc. and others.
|
jpayne@68
|
8 .\"
|
jpayne@68
|
9 .TH DERB 1 "7 Mar 2014" "ICU MANPAGE" "ICU 67.1 Manual"
|
jpayne@68
|
10 .SH NAME
|
jpayne@68
|
11 .B derb
|
jpayne@68
|
12 \- disassemble a resource bundle
|
jpayne@68
|
13 .SH SYNOPSIS
|
jpayne@68
|
14 .B derb
|
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 "\-v\fP, \fB\-\-verbose"
|
jpayne@68
|
23 ]
|
jpayne@68
|
24 [
|
jpayne@68
|
25 .BI "\-e\fP, \fB\-\-encoding" " encoding"
|
jpayne@68
|
26 ]
|
jpayne@68
|
27 [
|
jpayne@68
|
28 .BI "\-\-bom"
|
jpayne@68
|
29 ]
|
jpayne@68
|
30 [
|
jpayne@68
|
31 .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
|
jpayne@68
|
32 ]
|
jpayne@68
|
33 [
|
jpayne@68
|
34 .BI "\-s\fP, \fB\-\-sourcedir" " source"
|
jpayne@68
|
35 ]
|
jpayne@68
|
36 [
|
jpayne@68
|
37 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
jpayne@68
|
38 ]
|
jpayne@68
|
39 [
|
jpayne@68
|
40 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
jpayne@68
|
41 ]
|
jpayne@68
|
42 [
|
jpayne@68
|
43 .BI "\-c\fP, \fB\-\-to\-stdout"
|
jpayne@68
|
44 ]
|
jpayne@68
|
45 .IR bundle " \.\.\."
|
jpayne@68
|
46 .SH DESCRIPTION
|
jpayne@68
|
47 .B derb
|
jpayne@68
|
48 reads the compiled resource
|
jpayne@68
|
49 .I bundle
|
jpayne@68
|
50 files passed on the command line and write them back in text form.
|
jpayne@68
|
51 The resulting text files have a
|
jpayne@68
|
52 .B .txt
|
jpayne@68
|
53 extension while compiled resource bundle source files typically have a
|
jpayne@68
|
54 .B .res
|
jpayne@68
|
55 extension.
|
jpayne@68
|
56 .PP
|
jpayne@68
|
57 It is customary to name the resource bundles by their locale name,
|
jpayne@68
|
58 i.e. to use a local identifier for the
|
jpayne@68
|
59 .I bundle
|
jpayne@68
|
60 filename, e.g.
|
jpayne@68
|
61 .B ja_JP.res
|
jpayne@68
|
62 for Japanese (Japan) data, or
|
jpayne@68
|
63 .B root.res
|
jpayne@68
|
64 for the root bundle.
|
jpayne@68
|
65 This is especially important for
|
jpayne@68
|
66 .B derb
|
jpayne@68
|
67 since the locale name is not accessible directly from the compiled
|
jpayne@68
|
68 resource bundle, and to know which locale to ask for when opening
|
jpayne@68
|
69 the bundle.
|
jpayne@68
|
70 .B derb
|
jpayne@68
|
71 will produce a file whose base name is the base name of the compiled resource file itself.
|
jpayne@68
|
72 If the
|
jpayne@68
|
73 .BI "\-\-to\-stdout\fP, \fB\-c\fP"
|
jpayne@68
|
74 option is used, however, the text will be written on the standard output.
|
jpayne@68
|
75 .SH OPTIONS
|
jpayne@68
|
76 .TP
|
jpayne@68
|
77 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
jpayne@68
|
78 Print help about usage and exit.
|
jpayne@68
|
79 .TP
|
jpayne@68
|
80 .BR "\-V\fP, \fB\-\-version"
|
jpayne@68
|
81 Print the version of
|
jpayne@68
|
82 .B derb
|
jpayne@68
|
83 and exit.
|
jpayne@68
|
84 .TP
|
jpayne@68
|
85 .BR "\-v\fP, \fB\-\-verbose"
|
jpayne@68
|
86 Display extra informative messages during execution.
|
jpayne@68
|
87 .TP
|
jpayne@68
|
88 .BR "\-A\fP, \fB\-\-suppressAliases"
|
jpayne@68
|
89 Don't follow aliases when producing output.
|
jpayne@68
|
90 .TP
|
jpayne@68
|
91 .BI "\-e\fP, \fB\-\-encoding" " encoding"
|
jpayne@68
|
92 Set the encoding used to write output files to
|
jpayne@68
|
93 .IR encoding .
|
jpayne@68
|
94 The default encoding is the invariant (subset of ASCII or EBCDIC)
|
jpayne@68
|
95 codepage for the system (see section
|
jpayne@68
|
96 .BR "INVARIANT CHARACTERS" ).
|
jpayne@68
|
97 The choice of the encoding does not affect the data, just their
|
jpayne@68
|
98 representation. Characters that cannot be represented in the
|
jpayne@68
|
99 .I encoding
|
jpayne@68
|
100 will be represented using
|
jpayne@68
|
101 .BI \eu "hhhh"
|
jpayne@68
|
102 escape sequences.
|
jpayne@68
|
103 .TP
|
jpayne@68
|
104 .BI "\-\-bom"
|
jpayne@68
|
105 Write a byte order mark (BOM) at the beginning of the file.
|
jpayne@68
|
106 .TP
|
jpayne@68
|
107 .BI "\-l\fP, \fB\-\-locale" " locale"
|
jpayne@68
|
108 Set the
|
jpayne@68
|
109 .I locale
|
jpayne@68
|
110 for the resource bundle, which is used both in the generated text and
|
jpayne@68
|
111 as the base name of the output file.
|
jpayne@68
|
112 .TP
|
jpayne@68
|
113 .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
|
jpayne@68
|
114 Truncate individual resources (strings or binary data) to
|
jpayne@68
|
115 .I size
|
jpayne@68
|
116 bytes. The default if
|
jpayne@68
|
117 .I size
|
jpayne@68
|
118 is not specified is
|
jpayne@68
|
119 .B 80
|
jpayne@68
|
120 bytes.
|
jpayne@68
|
121 .TP
|
jpayne@68
|
122 .BI "\-s\fP, \fB\-\-sourcedir" " source"
|
jpayne@68
|
123 Set the source directory to
|
jpayne@68
|
124 .IR source .
|
jpayne@68
|
125 The default source directory is the current directory.
|
jpayne@68
|
126 If
|
jpayne@68
|
127 .B -
|
jpayne@68
|
128 is passed for
|
jpayne@68
|
129 .IR source ,
|
jpayne@68
|
130 then the
|
jpayne@68
|
131 .I bundle
|
jpayne@68
|
132 will be looked for in its default location, specified by
|
jpayne@68
|
133 the
|
jpayne@68
|
134 .B ICU_DATA
|
jpayne@68
|
135 environment variable (or defaulting to
|
jpayne@68
|
136 the location set when ICU was built if
|
jpayne@68
|
137 .B ICU_DATA
|
jpayne@68
|
138 is not set).
|
jpayne@68
|
139 .TP
|
jpayne@68
|
140 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
jpayne@68
|
141 Set the destination directory to
|
jpayne@68
|
142 .IR destination .
|
jpayne@68
|
143 The default destination directory is specified by the environment variable
|
jpayne@68
|
144 .BR ICU_DATA
|
jpayne@68
|
145 or is the location set when ICU was built if
|
jpayne@68
|
146 .B ICU_DATA
|
jpayne@68
|
147 is not set.
|
jpayne@68
|
148 .TP
|
jpayne@68
|
149 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
|
jpayne@68
|
150 Look for any necessary ICU data files in
|
jpayne@68
|
151 .IR directory .
|
jpayne@68
|
152 For example, when processing collation overrides, the file
|
jpayne@68
|
153 .B ucadata.dat
|
jpayne@68
|
154 must be located.
|
jpayne@68
|
155 The default ICU data directory is specified by the environment variable
|
jpayne@68
|
156 .BR ICU_DATA .
|
jpayne@68
|
157 .TP
|
jpayne@68
|
158 .BI "\-c\fP, \fB\-\-to\-stdout"
|
jpayne@68
|
159 Write the disassembled
|
jpayne@68
|
160 .I bundle
|
jpayne@68
|
161 on standard output instead of into a file.
|
jpayne@68
|
162 .SH CAVEATS
|
jpayne@68
|
163 When the option
|
jpayne@68
|
164 .BI \-\-bom
|
jpayne@68
|
165 is used, the character
|
jpayne@68
|
166 .B U+FEFF
|
jpayne@68
|
167 is written in the destination
|
jpayne@68
|
168 .I encoding
|
jpayne@68
|
169 regardless of whether it is a Unicode transformation format (UTF) or not.
|
jpayne@68
|
170 This option should only be used with an UTF encoding, as byte order marks
|
jpayne@68
|
171 are not meaningful for other encodings.
|
jpayne@68
|
172 .SH INVARIANT CHARACTERS
|
jpayne@68
|
173 The
|
jpayne@68
|
174 .B invariant character set
|
jpayne@68
|
175 consists of the following set of characters, expressed as a standard POSIX
|
jpayne@68
|
176 regular expression:
|
jpayne@68
|
177 .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
|
jpayne@68
|
178 This is the set which is guaranteed to be available regardless of code page.
|
jpayne@68
|
179 .SH ENVIRONMENT
|
jpayne@68
|
180 .TP 10
|
jpayne@68
|
181 .B ICU_DATA
|
jpayne@68
|
182 Specifies the directory containing ICU data. Defaults to
|
jpayne@68
|
183 .BR ${prefix}/share/icu/67.1/ .
|
jpayne@68
|
184 Some tools in ICU depend on the presence of the trailing slash. It is thus
|
jpayne@68
|
185 important to make sure that it is present if
|
jpayne@68
|
186 .B ICU_DATA
|
jpayne@68
|
187 is set.
|
jpayne@68
|
188 .SH AUTHORS
|
jpayne@68
|
189 Vladimir Weinstein
|
jpayne@68
|
190 .br
|
jpayne@68
|
191 Yves Arrouye
|
jpayne@68
|
192 .SH VERSION
|
jpayne@68
|
193 1.0
|
jpayne@68
|
194 .SH COPYRIGHT
|
jpayne@68
|
195 Copyright (C) 2002 IBM, Inc. and others.
|
jpayne@68
|
196 .SH SEE ALSO
|
jpayne@68
|
197 .BR genrb (1)
|
jpayne@68
|
198
|