genrb.1 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. .\" Hey, Emacs! This is -*-nroff-*- you know...
  2. .\"
  3. .\" genrb.1: manual page for the genrb 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-2002 IBM, Inc. and others.
  8. .\"
  9. .\" Manual page by Yves Arrouye <yves@realnames.com>.
  10. .\"
  11. .TH GENRB 1 "16 April 2002" "ICU MANPAGE" "ICU 58.2 Manual"
  12. .SH NAME
  13. .B genrb
  14. \- compile a resource bundle
  15. .SH SYNOPSIS
  16. .B genrb
  17. [
  18. .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  19. ]
  20. [
  21. .BR "\-V\fP, \fB\-\-version"
  22. ]
  23. [
  24. .BR "\-v\fP, \fB\-\-verbose"
  25. ]
  26. [
  27. .BI "\-e\fP, \fB\-\-encoding" " encoding"
  28. ]
  29. [
  30. .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
  31. ]
  32. [
  33. .BI "\-s\fP, \fB\-\-sourcedir" " source"
  34. ]
  35. [
  36. .BI "\-d\fP, \fB\-\-destdir" " destination"
  37. ]
  38. [
  39. .BI "\-i\fP, \fB\-\-icudatadir" " directory"
  40. ]
  41. .IR bundle " \.\.\."
  42. .SH DESCRIPTION
  43. .B genrb
  44. converts the resource
  45. .I bundle
  46. source files passed on the command line to their binary form or to
  47. a Java source file for use with ICU4J.
  48. The resulting binary files have a
  49. .B .res
  50. extension while resource bundle source files typically have a
  51. .B .txt
  52. extension. Java source files have a
  53. .B java
  54. extension and follow the ICU4J naming conventions.
  55. .PP
  56. It is customary to name the resource bundles by their locale name,
  57. i.e. to use a local identifier for the
  58. .I bundle
  59. filename, e.g.
  60. .B ja_JP.txt
  61. for Japanese (Japan) data, or
  62. .B root.txt
  63. for the root bundle.
  64. In any case,
  65. .B genrb
  66. will produce a file whose base name is the name of the locale found
  67. in the resource file, not the base name of the resource file itself.
  68. .PP
  69. The binary files can be read directly by ICU, or used by
  70. .BR pkgdata (1)
  71. for incorporation into a larger archive or library.
  72. .SH OPTIONS
  73. .TP
  74. .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
  75. Print help about usage and exit.
  76. .TP
  77. .BR "\-V\fP, \fB\-\-version"
  78. Print the version of
  79. .B genrb
  80. and exit.
  81. .TP
  82. .BR "\-v\fP, \fB\-\-verbose"
  83. Display extra informative messages during execution.
  84. .TP
  85. .BI "\-e\fP, \fB\-\-encoding" " encoding"
  86. Set the encoding used to read input files to
  87. .IR encoding .
  88. The default encoding is the invariant (subset of ASCII or EBCDIC)
  89. codepage for the system (see section
  90. .BR "INVARIANT CHARACTERS" ).
  91. The encodings UTF-8, UTF-16BE, and UTF-16LE are automatically detected
  92. if a byte order mark (BOM) is present.
  93. .TP
  94. .BI "\-j\fP, \fB\-\-write\-java" " \fR[ \fPencoding\fR ]\fP"
  95. Generate a Java source code for use with ICU4J. An optional
  96. .I encoding
  97. for the Java file can be given.
  98. .TP
  99. .BI "\-s\fP, \fB\-\-sourcedir" " source"
  100. Set the source directory to
  101. .IR source .
  102. The default source directory is specified by the environment variable
  103. .BR ICU_DATA ,
  104. or the location set when ICU was built if
  105. .B ICU_DATA
  106. is not set.
  107. .TP
  108. .BI "\-d\fP, \fB\-\-destdir" " destination"
  109. Set the destination directory to
  110. .IR destination .
  111. The default destination directory is specified by the environment variable
  112. .BR ICU_DATA
  113. or is the location set when ICU was built if
  114. .B ICU_DATA
  115. is not set.
  116. .TP
  117. .BI "\-i\fP, \fB\-\-icudatadir" " directory"
  118. Look for any necessary ICU data files in
  119. .IR directory .
  120. For example, when processing collation overrides, the file
  121. .B ucadata.dat
  122. must be located.
  123. The default ICU data directory is specified by the environment variable
  124. .BR ICU_DATA .
  125. .SH INVARIANT CHARACTERS
  126. The
  127. .B invariant character set
  128. consists of the following set of characters, expressed as a standard POSIX
  129. regular expression:
  130. .BR "[a-z]|[A-Z]|[0-9]|_| |+|-|*|/" .
  131. This is the set which is guaranteed to be available regardless of code page.
  132. .SH ENVIRONMENT
  133. .TP 10
  134. .B ICU_DATA
  135. Specifies the directory containing ICU data. Defaults to
  136. .BR ${prefix}/share/icu/58.2/ .
  137. Some tools in ICU depend on the presence of the trailing slash. It is thus
  138. important to make sure that it is present if
  139. .B ICU_DATA
  140. is set.
  141. .SH VERSION
  142. 58.2
  143. .SH COPYRIGHT
  144. Copyright (C) 2000-2002 IBM, Inc. and others.
  145. .SH SEE ALSO
  146. .BR derb (1)
  147. .br
  148. .BR pkgdata (1)