michael@0: .\" Hey, Emacs! This is -*-nroff-*- you know...
michael@0: .\"
michael@0: .\" derb.1: manual page for the derb utility
michael@0: .\"
michael@0: .\" Copyright (C) 2000-2002 IBM, Inc. and others.
michael@0: .\"
michael@0: .TH DERB 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
michael@0: .SH NAME
michael@0: .B derb
michael@0: \- disassemble a resource bundle
michael@0: .SH SYNOPSIS
michael@0: .B derb
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 "\-\-bom"
michael@0: ]
michael@0: [
michael@0: .BI "\-l\fP, \fB\-\-locale" " locale"
michael@0: ]
michael@0: [
michael@0: .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\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: [
michael@0: .BI "\-c\fP, \fB\-\-to\-stdout"
michael@0: ]
michael@0: .IR bundle " \.\.\."
michael@0: .SH DESCRIPTION
michael@0: .B derb
michael@0: reads the compiled resource
michael@0: .I bundle
michael@0: files passed on the command line and write them back in text form.
michael@0: The resulting text files have a
michael@0: .B .txt
michael@0: extension while compiled resource bundle source files typically have a 
michael@0: .B .res
michael@0: extension.
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.res
michael@0: for Japanese (Japan) data, or
michael@0: .B root.res
michael@0: for the root bundle.
michael@0: This is especially important for
michael@0: .B derb
michael@0: since the locale name is not accessible directly from the compiled
michael@0: resource bundle, and to know which locale to ask for when opening
michael@0: the bundle.
michael@0: .B derb
michael@0: will produce a file whose base name is either the value of the
michael@0: .BI "\-l\fP, \fB\-\-locale"
michael@0: option, or the same as the base name of the compiled resource file itself.
michael@0: If the
michael@0: .BI "\-\-to\-stdout\fP, \fB\-c\fP"
michael@0: option is used, however, the text will be written on the standard output.
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 derb
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 write output 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 choice of the encoding does not affect the data, just their
michael@0: representation. Characters that cannot be represented in the
michael@0: .I encoding
michael@0: will be represented using
michael@0: .BI \eu "hhhh"
michael@0: escape sequences.
michael@0: .TP
michael@0: .BI "\-\-bom"
michael@0: Write a byte order mark (BOM) at the beginning of the file.
michael@0: .TP
michael@0: .BI "\-l\fP, \fB\-\-locale" " locale"
michael@0: Set the
michael@0: .I locale
michael@0: for the resource bundle, which is used both in the generated text and
michael@0: as the base name of the output file.
michael@0: .TP
michael@0: .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
michael@0: Truncate individual resources (strings or binary data) to
michael@0: .I size
michael@0: bytes. The default if
michael@0: .I size
michael@0: is not specified is
michael@0: .B 80
michael@0: bytes.
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 the current directory.
michael@0: If 
michael@0: .B -
michael@0: is passed for
michael@0: .IR source ,
michael@0: then the
michael@0: .I bundle
michael@0: will be looked for in its default location, specified by
michael@0: the 
michael@0: .B ICU_DATA
michael@0: environment variable (or defaulting to
michael@0: 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: .TP
michael@0: .BI "\-c\fP, \fB\-\-to\-stdout"
michael@0: Write the disassembled
michael@0: .I bundle
michael@0: on standard output instead of into a file.
michael@0: .SH CAVEATS
michael@0: When the option
michael@0: .BI \-\-bom
michael@0: is used, the character
michael@0: .B U+FEFF
michael@0: is written in the destination
michael@0: .I encoding
michael@0: regardless of whether it is a Unicode transformation format (UTF) or not.
michael@0: This option should only be used with an UTF encoding, as byte order marks
michael@0: are not meaningful for other encodings.
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 AUTHORS
michael@0: Vladimir Weinstein
michael@0: .br
michael@0: Yves Arrouye
michael@0: .SH VERSION
michael@0: 1.0
michael@0: .SH COPYRIGHT
michael@0: Copyright (C) 2002 IBM, Inc. and others.
michael@0: .SH SEE ALSO
michael@0: .BR genrb (1)
michael@0: