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