icuSources/tools/genrb/derb.1.in

   1 .\" Hey, Emacs! This is -*-nroff-*- you know...
   2 .\"
   3 .\" derb.1: manual page for the derb utility
   4 .\"
   5 .\" Copyright (C) 2000-2014 IBM, Inc. and others.
   6 .\"
   7 .TH DERB 1 "7 Mar 2014" "ICU MANPAGE" "ICU @VERSION@ Manual"
   8 .SH NAME
   9 .B derb
  10 \- disassemble a resource bundle
  11 .SH SYNOPSIS
  12 .B derb
  13 [
  14 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  15 ]
  16 [
  17 .BR "\-V\fP, \fB\-\-version"
  18 ]
  19 [
  20 .BR "\-v\fP, \fB\-\-verbose"
  21 ]
  22 [
  23 .BI "\-e\fP, \fB\-\-encoding" " encoding"
  24 ]
  25 [
  26 .BI "\-\-bom"
  27 ]
  28 [
  29 .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
  30 ]
  31 [
  32 .BI "\-s\fP, \fB\-\-sourcedir" " source"
  33 ]
  34 [
  35 .BI "\-d\fP, \fB\-\-destdir" " destination"
  36 ]
  37 [
  38 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
  39 ]
  40 [
  41 .BI "\-c\fP, \fB\-\-to\-stdout"
  42 ]
  43 .IR bundle " \.\.\."
  44 .SH DESCRIPTION
  45 .B derb
  46 reads the compiled resource
  47 .I bundle
  48 files passed on the command line and write them back in text form.
  49 The resulting text files have a
  50 .B .txt
  51 extension while compiled resource bundle source files typically have a
  52 .B .res
  53 extension.
  54 .PP
  55 It is customary to name the resource bundles by their locale name,
  56 i.e. to use a local identifier for the
  57 .I bundle
  58 filename, e.g.
  59 .B ja_JP.res
  60 for Japanese (Japan) data, or
  61 .B root.res
  62 for the root bundle.
  63 This is especially important for
  64 .B derb
  65 since the locale name is not accessible directly from the compiled
  66 resource bundle, and to know which locale to ask for when opening
  67 the bundle.
  68 .B derb
  69 will produce a file whose base name is the base name of the compiled resource file itself.
  70 If the
  71 .BI "\-\-to\-stdout\fP, \fB\-c\fP"
  72 option is used, however, the text will be written on the standard output.
  73 .SH OPTIONS
  74 .TP
  75 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  76 Print help about usage and exit.
  77 .TP
  78 .BR "\-V\fP, \fB\-\-version"
  79 Print the version of
  80 .B derb
  81 and exit.
  82 .TP
  83 .BR "\-v\fP, \fB\-\-verbose"
  84 Display extra informative messages during execution.
  85 .TP
  86 .BR "\-A\fP, \fB\-\-suppressAliases"
  87 Don't follow aliases when producing output.
  88 .TP
  89 .BI "\-e\fP, \fB\-\-encoding" " encoding"
  90 Set the encoding used to write output files to
  91 .IR encoding .
  92 The default encoding is the invariant (subset of ASCII or EBCDIC)
  93 codepage for the system (see section
  94 .BR "INVARIANT CHARACTERS" ).
  95 The choice of the encoding does not affect the data, just their
  96 representation. Characters that cannot be represented in the
  97 .I encoding
  98 will be represented using
  99 .BI \eu "hhhh"
 100 escape sequences.
 101 .TP
 102 .BI "\-\-bom"
 103 Write a byte order mark (BOM) at the beginning of the file.
 104 .TP
 105 .BI "\-l\fP, \fB\-\-locale" " locale"
 106 Set the
 107 .I locale
 108 for the resource bundle, which is used both in the generated text and
 109 as the base name of the output file.
 110 .TP
 111 .BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
 112 Truncate individual resources (strings or binary data) to
 113 .I size
 114 bytes. The default if
 115 .I size
 116 is not specified is
 117 .B 80
 118 bytes.
 119 .TP
 120 .BI "\-s\fP, \fB\-\-sourcedir" " source"
 121 Set the source directory to
 122 .IR source .
 123 The default source directory is the current directory.
 124 If
 125 .B -
 126 is passed for
 127 .IR source ,
 128 then the
 129 .I bundle
 130 will be looked for in its default location, specified by
 131 the
 132 .B ICU_DATA
 133 environment variable (or defaulting to
 134 the location set when ICU was built if
 135 .B ICU_DATA
 136 is not set).
 137 .TP
 138 .BI "\-d\fP, \fB\-\-destdir" " destination"
 139 Set the destination directory to
 140 .IR destination .
 141 The default destination directory is specified by the environment variable
 142 .BR ICU_DATA
 143 or is the location set when ICU was built if
 144 .B ICU_DATA
 145 is not set.
 146 .TP
 147 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
 148 Look for any necessary ICU data files in
 149 .IR directory .
 150 For example, when processing collation overrides, the file
 151 .B ucadata.dat
 152 must be located.
 153 The default ICU data directory is specified by the environment variable
 154 .BR ICU_DATA .
 155 .TP
 156 .BI "\-c\fP, \fB\-\-to\-stdout"
 157 Write the disassembled
 158 .I bundle
 159 on standard output instead of into a file.
 160 .SH CAVEATS
 161 When the option
 162 .BI \-\-bom
 163 is used, the character
 164 .B U+FEFF
 165 is written in the destination
 166 .I encoding
 167 regardless of whether it is a Unicode transformation format (UTF) or not.
 168 This option should only be used with an UTF encoding, as byte order marks
 169 are not meaningful for other encodings.
 170 .SH INVARIANT CHARACTERS
 171 The
 172 .B invariant character set
 173 consists of the following set of characters, expressed as a standard POSIX
 174 regular expression:
 175 .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
 176 This is the set which is guaranteed to be available regardless of code page.
 177 .SH ENVIRONMENT
 178 .TP 10
 179 .B ICU_DATA
 180 Specifies the directory containing ICU data. Defaults to
 181 .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
 182 Some tools in ICU depend on the presence of the trailing slash. It is thus
 183 important to make sure that it is present if
 184 .B ICU_DATA
 185 is set.
 186 .SH AUTHORS
 187 Vladimir Weinstein
 188 .br
 189 Yves Arrouye
 190 .SH VERSION
 191 1.0
 192 .SH COPYRIGHT
 193 Copyright (C) 2002 IBM, Inc. and others.
 194 .SH SEE ALSO
 195 .BR genrb (1)
 196