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