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