1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/genrb/genrb.1.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,146 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" genrb.1: manual page for the genrb utility
1.7 +.\"
1.8 +.\" Copyright (C) 2000-2002 IBM, Inc. and others.
1.9 +.\"
1.10 +.\" Manual page by Yves Arrouye <yves@realnames.com>.
1.11 +.\"
1.12 +.TH GENRB 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.13 +.SH NAME
1.14 +.B genrb
1.15 +\- compile a resource bundle
1.16 +.SH SYNOPSIS
1.17 +.B genrb
1.18 +[
1.19 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.20 +]
1.21 +[
1.22 +.BR "\-V\fP, \fB\-\-version"
1.23 +]
1.24 +[
1.25 +.BR "\-v\fP, \fB\-\-verbose"
1.26 +]
1.27 +[
1.28 +.BI "\-e\fP, \fB\-\-encoding" " encoding"
1.29 +]
1.30 +[
1.31 +.BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
1.32 +]
1.33 +[
1.34 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.35 +]
1.36 +[
1.37 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.38 +]
1.39 +[
1.40 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.41 +]
1.42 +.IR bundle " \.\.\."
1.43 +.SH DESCRIPTION
1.44 +.B genrb
1.45 +converts the resource
1.46 +.I bundle
1.47 +source files passed on the command line to their binary form or to
1.48 +a Java source file for use with ICU4J.
1.49 +The resulting binary files have a
1.50 +.B .res
1.51 +extension while resource bundle source files typically have a
1.52 +.B .txt
1.53 +extension. Java source files have a
1.54 +.B java
1.55 +extension and follow the ICU4J naming conventions.
1.56 +.PP
1.57 +It is customary to name the resource bundles by their locale name,
1.58 +i.e. to use a local identifier for the
1.59 +.I bundle
1.60 +filename, e.g.
1.61 +.B ja_JP.txt
1.62 +for Japanese (Japan) data, or
1.63 +.B root.txt
1.64 +for the root bundle.
1.65 +In any case,
1.66 +.B genrb
1.67 +will produce a file whose base name is the name of the locale found
1.68 +in the resource file, not the base name of the resource file itself.
1.69 +.PP
1.70 +The binary files can be read directly by ICU, or used by
1.71 +.BR pkgdata (1)
1.72 +for incorporation into a larger archive or library.
1.73 +.SH OPTIONS
1.74 +.TP
1.75 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.76 +Print help about usage and exit.
1.77 +.TP
1.78 +.BR "\-V\fP, \fB\-\-version"
1.79 +Print the version of
1.80 +.B genrb
1.81 +and exit.
1.82 +.TP
1.83 +.BR "\-v\fP, \fB\-\-verbose"
1.84 +Display extra informative messages during execution.
1.85 +.TP
1.86 +.BI "\-e\fP, \fB\-\-encoding" " encoding"
1.87 +Set the encoding used to read input files to
1.88 +.IR encoding .
1.89 +The default encoding is the invariant (subset of ASCII or EBCDIC)
1.90 +codepage for the system (see section
1.91 +.BR "INVARIANT CHARACTERS" ).
1.92 +The encodings UTF-8, UTF-16BE, and UTF-16LE are automatically detected
1.93 +if a byte order mark (BOM) is present.
1.94 +.TP
1.95 +.BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
1.96 +Generate a Java source code for use with ICU4J. An optional
1.97 +.I encoding
1.98 +for the Java file can be given.
1.99 +.TP
1.100 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.101 +Set the source directory to
1.102 +.IR source .
1.103 +The default source directory is specified by the environment variable
1.104 +.BR ICU_DATA ,
1.105 +or the location set when ICU was built if
1.106 +.B ICU_DATA
1.107 +is not set.
1.108 +.TP
1.109 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.110 +Set the destination directory to
1.111 +.IR destination .
1.112 +The default destination directory is specified by the environment variable
1.113 +.BR ICU_DATA
1.114 +or is the location set when ICU was built if
1.115 +.B ICU_DATA
1.116 +is not set.
1.117 +.TP
1.118 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.119 +Look for any necessary ICU data files in
1.120 +.IR directory .
1.121 +For example, when processing collation overrides, the file
1.122 +.B ucadata.dat
1.123 +must be located.
1.124 +The default ICU data directory is specified by the environment variable
1.125 +.BR ICU_DATA .
1.126 +.SH INVARIANT CHARACTERS
1.127 +The
1.128 +.B invariant character set
1.129 +consists of the following set of characters, expressed as a standard POSIX
1.130 +regular expression:
1.131 +.BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
1.132 +This is the set which is guaranteed to be available regardless of code page.
1.133 +.SH ENVIRONMENT
1.134 +.TP 10
1.135 +.B ICU_DATA
1.136 +Specifies the directory containing ICU data. Defaults to
1.137 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.138 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.139 +important to make sure that it is present if
1.140 +.B ICU_DATA
1.141 +is set.
1.142 +.SH VERSION
1.143 +@VERSION@
1.144 +.SH COPYRIGHT
1.145 +Copyright (C) 2000-2002 IBM, Inc. and others.
1.146 +.SH SEE ALSO
1.147 +.BR derb (1)
1.148 +.br
1.149 +.BR pkgdata (1)
