jpayne@68: .\" Hey, Emacs! This is -*-nroff-*- you know...
jpayne@68: .\"
jpayne@68: .\" derb.1: manual page for the derb utility
jpayne@68: .\"
jpayne@68: .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
jpayne@68: .\" License & terms of use: http://www.unicode.org/copyright.html
jpayne@68: .\" Copyright (C) 2000-2014 IBM, Inc. and others.
jpayne@68: .\"
jpayne@68: .TH DERB 1 "7 Mar 2014" "ICU MANPAGE" "ICU 67.1 Manual"
jpayne@68: .SH NAME
jpayne@68: .B derb
jpayne@68: \- disassemble a resource bundle
jpayne@68: .SH SYNOPSIS
jpayne@68: .B derb
jpayne@68: [
jpayne@68: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BR "\-V\fP, \fB\-\-version"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BR "\-v\fP, \fB\-\-verbose"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-e\fP, \fB\-\-encoding" " encoding"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-bom"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-s\fP, \fB\-\-sourcedir" " source"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-c\fP, \fB\-\-to\-stdout"
jpayne@68: ]
jpayne@68: .IR bundle " \.\.\."
jpayne@68: .SH DESCRIPTION
jpayne@68: .B derb
jpayne@68: reads the compiled resource
jpayne@68: .I bundle
jpayne@68: files passed on the command line and write them back in text form.
jpayne@68: The resulting text files have a
jpayne@68: .B .txt
jpayne@68: extension while compiled resource bundle source files typically have a 
jpayne@68: .B .res
jpayne@68: extension.
jpayne@68: .PP
jpayne@68: It is customary to name the resource bundles by their locale name,
jpayne@68: i.e. to use a local identifier for the
jpayne@68: .I bundle
jpayne@68: filename, e.g.
jpayne@68: .B ja_JP.res
jpayne@68: for Japanese (Japan) data, or
jpayne@68: .B root.res
jpayne@68: for the root bundle.
jpayne@68: This is especially important for
jpayne@68: .B derb
jpayne@68: since the locale name is not accessible directly from the compiled
jpayne@68: resource bundle, and to know which locale to ask for when opening
jpayne@68: the bundle.
jpayne@68: .B derb
jpayne@68: will produce a file whose base name is the base name of the compiled resource file itself.
jpayne@68: If the
jpayne@68: .BI "\-\-to\-stdout\fP, \fB\-c\fP"
jpayne@68: option is used, however, the text will be written on the standard output.
jpayne@68: .SH OPTIONS
jpayne@68: .TP
jpayne@68: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68: Print help about usage and exit.
jpayne@68: .TP
jpayne@68: .BR "\-V\fP, \fB\-\-version"
jpayne@68: Print the version of
jpayne@68: .B derb
jpayne@68: and exit.
jpayne@68: .TP
jpayne@68: .BR "\-v\fP, \fB\-\-verbose"
jpayne@68: Display extra informative messages during execution.
jpayne@68: .TP
jpayne@68: .BR "\-A\fP, \fB\-\-suppressAliases"
jpayne@68: Don't follow aliases when producing output.
jpayne@68: .TP
jpayne@68: .BI "\-e\fP, \fB\-\-encoding" " encoding"
jpayne@68: Set the encoding used to write output files to
jpayne@68: .IR encoding .
jpayne@68: The default encoding is the invariant (subset of ASCII or EBCDIC)
jpayne@68: codepage for the system (see section
jpayne@68: .BR "INVARIANT CHARACTERS" ).
jpayne@68: The choice of the encoding does not affect the data, just their
jpayne@68: representation. Characters that cannot be represented in the
jpayne@68: .I encoding
jpayne@68: will be represented using
jpayne@68: .BI \eu "hhhh"
jpayne@68: escape sequences.
jpayne@68: .TP
jpayne@68: .BI "\-\-bom"
jpayne@68: Write a byte order mark (BOM) at the beginning of the file.
jpayne@68: .TP
jpayne@68: .BI "\-l\fP, \fB\-\-locale" " locale"
jpayne@68: Set the
jpayne@68: .I locale
jpayne@68: for the resource bundle, which is used both in the generated text and
jpayne@68: as the base name of the output file.
jpayne@68: .TP
jpayne@68: .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
jpayne@68: Truncate individual resources (strings or binary data) to
jpayne@68: .I size
jpayne@68: bytes. The default if
jpayne@68: .I size
jpayne@68: is not specified is
jpayne@68: .B 80
jpayne@68: bytes.
jpayne@68: .TP
jpayne@68: .BI "\-s\fP, \fB\-\-sourcedir" " source"
jpayne@68: Set the source directory to
jpayne@68: .IR source .
jpayne@68: The default source directory is the current directory.
jpayne@68: If 
jpayne@68: .B -
jpayne@68: is passed for
jpayne@68: .IR source ,
jpayne@68: then the
jpayne@68: .I bundle
jpayne@68: will be looked for in its default location, specified by
jpayne@68: the 
jpayne@68: .B ICU_DATA
jpayne@68: environment variable (or defaulting to
jpayne@68: the location set when ICU was built if 
jpayne@68: .B ICU_DATA
jpayne@68: is not set).
jpayne@68: .TP
jpayne@68: .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68: Set the destination directory to
jpayne@68: .IR destination .
jpayne@68: The default destination directory is specified by the environment variable
jpayne@68: .BR ICU_DATA
jpayne@68: or is the location set when ICU was built if 
jpayne@68: .B ICU_DATA
jpayne@68: is not set.
jpayne@68: .TP
jpayne@68: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
jpayne@68: Look for any necessary ICU data files in
jpayne@68: .IR directory .
jpayne@68: For example, when processing collation overrides, the file
jpayne@68: .B ucadata.dat
jpayne@68: must be located.
jpayne@68: The default ICU data directory is specified by the environment variable
jpayne@68: .BR ICU_DATA .
jpayne@68: .TP
jpayne@68: .BI "\-c\fP, \fB\-\-to\-stdout"
jpayne@68: Write the disassembled
jpayne@68: .I bundle
jpayne@68: on standard output instead of into a file.
jpayne@68: .SH CAVEATS
jpayne@68: When the option
jpayne@68: .BI \-\-bom
jpayne@68: is used, the character
jpayne@68: .B U+FEFF
jpayne@68: is written in the destination
jpayne@68: .I encoding
jpayne@68: regardless of whether it is a Unicode transformation format (UTF) or not.
jpayne@68: This option should only be used with an UTF encoding, as byte order marks
jpayne@68: are not meaningful for other encodings.
jpayne@68: .SH INVARIANT CHARACTERS
jpayne@68: The
jpayne@68: .B invariant character set
jpayne@68: consists of the following set of characters, expressed as a standard POSIX
jpayne@68: regular expression:
jpayne@68: .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
jpayne@68: This is the set which is guaranteed to be available regardless of code page.
jpayne@68: .SH ENVIRONMENT
jpayne@68: .TP 10
jpayne@68: .B ICU_DATA
jpayne@68: Specifies the directory containing ICU data. Defaults to
jpayne@68: .BR ${prefix}/share/icu/67.1/ .
jpayne@68: Some tools in ICU depend on the presence of the trailing slash. It is thus
jpayne@68: important to make sure that it is present if
jpayne@68: .B ICU_DATA
jpayne@68: is set.
jpayne@68: .SH AUTHORS
jpayne@68: Vladimir Weinstein
jpayne@68: .br
jpayne@68: Yves Arrouye
jpayne@68: .SH VERSION
jpayne@68: 1.0
jpayne@68: .SH COPYRIGHT
jpayne@68: Copyright (C) 2002 IBM, Inc. and others.
jpayne@68: .SH SEE ALSO
jpayne@68: .BR genrb (1)
jpayne@68: