1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/genrb/derb.1.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,198 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" derb.1: manual page for the derb utility
1.7 +.\"
1.8 +.\" Copyright (C) 2000-2002 IBM, Inc. and others.
1.9 +.\"
1.10 +.TH DERB 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.11 +.SH NAME
1.12 +.B derb
1.13 +\- disassemble a resource bundle
1.14 +.SH SYNOPSIS
1.15 +.B derb
1.16 +[
1.17 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.18 +]
1.19 +[
1.20 +.BR "\-V\fP, \fB\-\-version"
1.21 +]
1.22 +[
1.23 +.BR "\-v\fP, \fB\-\-verbose"
1.24 +]
1.25 +[
1.26 +.BI "\-e\fP, \fB\-\-encoding" " encoding"
1.27 +]
1.28 +[
1.29 +.BI "\-\-bom"
1.30 +]
1.31 +[
1.32 +.BI "\-l\fP, \fB\-\-locale" " locale"
1.33 +]
1.34 +[
1.35 +.BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
1.36 +]
1.37 +[
1.38 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.39 +]
1.40 +[
1.41 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.42 +]
1.43 +[
1.44 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.45 +]
1.46 +[
1.47 +.BI "\-c\fP, \fB\-\-to\-stdout"
1.48 +]
1.49 +.IR bundle " \.\.\."
1.50 +.SH DESCRIPTION
1.51 +.B derb
1.52 +reads the compiled resource
1.53 +.I bundle
1.54 +files passed on the command line and write them back in text form.
1.55 +The resulting text files have a
1.56 +.B .txt
1.57 +extension while compiled resource bundle source files typically have a
1.58 +.B .res
1.59 +extension.
1.60 +.PP
1.61 +It is customary to name the resource bundles by their locale name,
1.62 +i.e. to use a local identifier for the
1.63 +.I bundle
1.64 +filename, e.g.
1.65 +.B ja_JP.res
1.66 +for Japanese (Japan) data, or
1.67 +.B root.res
1.68 +for the root bundle.
1.69 +This is especially important for
1.70 +.B derb
1.71 +since the locale name is not accessible directly from the compiled
1.72 +resource bundle, and to know which locale to ask for when opening
1.73 +the bundle.
1.74 +.B derb
1.75 +will produce a file whose base name is either the value of the
1.76 +.BI "\-l\fP, \fB\-\-locale"
1.77 +option, or the same as the base name of the compiled resource file itself.
1.78 +If the
1.79 +.BI "\-\-to\-stdout\fP, \fB\-c\fP"
1.80 +option is used, however, the text will be written on the standard output.
1.81 +.SH OPTIONS
1.82 +.TP
1.83 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.84 +Print help about usage and exit.
1.85 +.TP
1.86 +.BR "\-V\fP, \fB\-\-version"
1.87 +Print the version of
1.88 +.B derb
1.89 +and exit.
1.90 +.TP
1.91 +.BR "\-v\fP, \fB\-\-verbose"
1.92 +Display extra informative messages during execution.
1.93 +.TP
1.94 +.BI "\-e\fP, \fB\-\-encoding" " encoding"
1.95 +Set the encoding used to write output files to
1.96 +.IR encoding .
1.97 +The default encoding is the invariant (subset of ASCII or EBCDIC)
1.98 +codepage for the system (see section
1.99 +.BR "INVARIANT CHARACTERS" ).
1.100 +The choice of the encoding does not affect the data, just their
1.101 +representation. Characters that cannot be represented in the
1.102 +.I encoding
1.103 +will be represented using
1.104 +.BI \eu "hhhh"
1.105 +escape sequences.
1.106 +.TP
1.107 +.BI "\-\-bom"
1.108 +Write a byte order mark (BOM) at the beginning of the file.
1.109 +.TP
1.110 +.BI "\-l\fP, \fB\-\-locale" " locale"
1.111 +Set the
1.112 +.I locale
1.113 +for the resource bundle, which is used both in the generated text and
1.114 +as the base name of the output file.
1.115 +.TP
1.116 +.BI "\-t\fP, \fB\-\-truncate" " \fR[ \fPsize\fR ]\fP"
1.117 +Truncate individual resources (strings or binary data) to
1.118 +.I size
1.119 +bytes. The default if
1.120 +.I size
1.121 +is not specified is
1.122 +.B 80
1.123 +bytes.
1.124 +.TP
1.125 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.126 +Set the source directory to
1.127 +.IR source .
1.128 +The default source directory is the current directory.
1.129 +If
1.130 +.B -
1.131 +is passed for
1.132 +.IR source ,
1.133 +then the
1.134 +.I bundle
1.135 +will be looked for in its default location, specified by
1.136 +the
1.137 +.B ICU_DATA
1.138 +environment variable (or defaulting to
1.139 +the location set when ICU was built if
1.140 +.B ICU_DATA
1.141 +is not set).
1.142 +.TP
1.143 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.144 +Set the destination directory to
1.145 +.IR destination .
1.146 +The default destination directory is specified by the environment variable
1.147 +.BR ICU_DATA
1.148 +or is the location set when ICU was built if
1.149 +.B ICU_DATA
1.150 +is not set.
1.151 +.TP
1.152 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.153 +Look for any necessary ICU data files in
1.154 +.IR directory .
1.155 +For example, when processing collation overrides, the file
1.156 +.B ucadata.dat
1.157 +must be located.
1.158 +The default ICU data directory is specified by the environment variable
1.159 +.BR ICU_DATA .
1.160 +.TP
1.161 +.BI "\-c\fP, \fB\-\-to\-stdout"
1.162 +Write the disassembled
1.163 +.I bundle
1.164 +on standard output instead of into a file.
1.165 +.SH CAVEATS
1.166 +When the option
1.167 +.BI \-\-bom
1.168 +is used, the character
1.169 +.B U+FEFF
1.170 +is written in the destination
1.171 +.I encoding
1.172 +regardless of whether it is a Unicode transformation format (UTF) or not.
1.173 +This option should only be used with an UTF encoding, as byte order marks
1.174 +are not meaningful for other encodings.
1.175 +.SH INVARIANT CHARACTERS
1.176 +The
1.177 +.B invariant character set
1.178 +consists of the following set of characters, expressed as a standard POSIX
1.179 +regular expression:
1.180 +.BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
1.181 +This is the set which is guaranteed to be available regardless of code page.
1.182 +.SH ENVIRONMENT
1.183 +.TP 10
1.184 +.B ICU_DATA
1.185 +Specifies the directory containing ICU data. Defaults to
1.186 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.187 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.188 +important to make sure that it is present if
1.189 +.B ICU_DATA
1.190 +is set.
1.191 +.SH AUTHORS
1.192 +Vladimir Weinstein
1.193 +.br
1.194 +Yves Arrouye
1.195 +.SH VERSION
1.196 +1.0
1.197 +.SH COPYRIGHT
1.198 +Copyright (C) 2002 IBM, Inc. and others.
1.199 +.SH SEE ALSO
1.200 +.BR genrb (1)
1.201 +
