michael@0: .\" Hey, Emacs! This is -*-nroff-*- you know...
michael@0: .\"
michael@0: .\" genrb.1: manual page for the genrb utility
michael@0: .\"
michael@0: .\" Copyright (C) 2000-2002 IBM, Inc. and others.
michael@0: .\"
michael@0: .\" Manual page by Yves Arrouye <yves@realnames.com>.
michael@0: .\"
michael@0: .TH GENRB 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
michael@0: .SH NAME
michael@0: .B genrb
michael@0: \- compile a resource bundle
michael@0: .SH SYNOPSIS
michael@0: .B genrb
michael@0: [
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: ]
michael@0: [
michael@0: .BR "\-V\fP, \fB\-\-version"
michael@0: ]
michael@0: [
michael@0: .BR "\-v\fP, \fB\-\-verbose"
michael@0: ]
michael@0: [
michael@0: .BI "\-e\fP, \fB\-\-encoding" " encoding"
michael@0: ]
michael@0: [
michael@0: .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
michael@0: ]
michael@0: [
michael@0: .BI "\-s\fP, \fB\-\-sourcedir" " source"
michael@0: ]
michael@0: [
michael@0: .BI "\-d\fP, \fB\-\-destdir" " destination"
michael@0: ]
michael@0: [
michael@0: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
michael@0: ]
michael@0: .IR bundle " \.\.\."
michael@0: .SH DESCRIPTION
michael@0: .B genrb
michael@0: converts the resource
michael@0: .I bundle
michael@0: source files passed on the command line to their binary form or to
michael@0: a Java source file for use with ICU4J.
michael@0: The resulting binary files have a
michael@0: .B .res
michael@0: extension while resource bundle source files typically have a 
michael@0: .B .txt
michael@0: extension. Java source files have a
michael@0: .B java
michael@0: extension and follow the ICU4J naming conventions.
michael@0: .PP
michael@0: It is customary to name the resource bundles by their locale name,
michael@0: i.e. to use a local identifier for the
michael@0: .I bundle
michael@0: filename, e.g.
michael@0: .B ja_JP.txt
michael@0: for Japanese (Japan) data, or
michael@0: .B root.txt
michael@0: for the root bundle.
michael@0: In any case,
michael@0: .B genrb
michael@0: will produce a file whose base name is the name of the locale found
michael@0: in the resource file, not the base name of the resource file itself.
michael@0: .PP
michael@0: The binary files can be read directly by ICU, or used by
michael@0: .BR pkgdata (1)
michael@0: for incorporation into a larger archive or library.
michael@0: .SH OPTIONS
michael@0: .TP
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: Print help about usage and exit.
michael@0: .TP
michael@0: .BR "\-V\fP, \fB\-\-version"
michael@0: Print the version of
michael@0: .B genrb
michael@0: and exit.
michael@0: .TP
michael@0: .BR "\-v\fP, \fB\-\-verbose"
michael@0: Display extra informative messages during execution.
michael@0: .TP
michael@0: .BI "\-e\fP, \fB\-\-encoding" " encoding"
michael@0: Set the encoding used to read input files to
michael@0: .IR encoding .
michael@0: The default encoding is the invariant (subset of ASCII or EBCDIC)
michael@0: codepage for the system (see section
michael@0: .BR "INVARIANT CHARACTERS" ).
michael@0: The encodings UTF-8, UTF-16BE, and UTF-16LE are automatically detected
michael@0: if a byte order mark (BOM) is present.
michael@0: .TP
michael@0: .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
michael@0: Generate a Java source code for use with ICU4J. An optional
michael@0: .I encoding
michael@0: for the Java file can be given.
michael@0: .TP
michael@0: .BI "\-s\fP, \fB\-\-sourcedir" " source"
michael@0: Set the source directory to
michael@0: .IR source .
michael@0: The default source directory is specified by the environment variable
michael@0: .BR ICU_DATA ,
michael@0: or the location set when ICU was built if 
michael@0: .B ICU_DATA
michael@0: is not set.
michael@0: .TP
michael@0: .BI "\-d\fP, \fB\-\-destdir" " destination"
michael@0: Set the destination directory to
michael@0: .IR destination .
michael@0: The default destination directory is specified by the environment variable
michael@0: .BR ICU_DATA
michael@0: or is the location set when ICU was built if 
michael@0: .B ICU_DATA
michael@0: is not set.
michael@0: .TP
michael@0: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
michael@0: Look for any necessary ICU data files in
michael@0: .IR directory .
michael@0: For example, when processing collation overrides, the file
michael@0: .B ucadata.dat
michael@0: must be located.
michael@0: The default ICU data directory is specified by the environment variable
michael@0: .BR ICU_DATA .
michael@0: .SH INVARIANT CHARACTERS
michael@0: The
michael@0: .B invariant character set
michael@0: consists of the following set of characters, expressed as a standard POSIX
michael@0: regular expression:
michael@0: .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
michael@0: This is the set which is guaranteed to be available regardless of code page.
michael@0: .SH ENVIRONMENT
michael@0: .TP 10
michael@0: .B ICU_DATA
michael@0: Specifies the directory containing ICU data. Defaults to
michael@0: .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
michael@0: Some tools in ICU depend on the presence of the trailing slash. It is thus
michael@0: important to make sure that it is present if
michael@0: .B ICU_DATA
michael@0: is set.
michael@0: .SH VERSION
michael@0: @VERSION@
michael@0: .SH COPYRIGHT
michael@0: Copyright (C) 2000-2002 IBM, Inc. and others.
michael@0: .SH SEE ALSO
michael@0: .BR derb (1)
michael@0: .br
michael@0: .BR pkgdata (1)