derb.1 4.8 KB

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