1
.\" Hey, Emacs! This is -*-nroff-*- you know...
3
.\" pkgdata.8: manual page for the pkgdata utility
5
.\" Copyright (C) 2000-2002 IBM, Inc. and others.
7
.\" Manual page by Yves Arrouye <yves@realnames.com>.
8
.\" Modified by Steven R. Loomis <srl@jtcsv.com>
10
.TH PKGDATA 8 "1 March 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
13
\- package data for use by ICU
17
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
20
.BI "\-v\fP, \fB\-\-verbose"
23
.BR "\-c\fP, \fB\-\-copyright"
25
.BI "\-C\fP, \fB\-\-comment" " comment"
28
.BI "\-m\fP, \fB\-\-mode" " mode"
30
.BI "\-p\fP, \fB\-\-name" " name"
31
.BI "\-O\fP, \fB\-\-bldopt" " options"
33
.BI "\-e\fP, \fB\-\-entrypoint" " name"
36
.BI "\-r\fP, \fB\-\-revision" " version"
42
.BI "\-F\fP, \fB\-\-rebuild"
45
.BI "\-k\fP, \fB\-\-clean"
48
.BI "\-I\fP, \fB\-\-install"
51
.BI "\-n\fP, \fB\-\-nooutput"
54
.BI "\-s\fP, \fB\-\-sourcedir" " source"
57
.BI "\-d\fP, \fB\-\-destdir" " destination"
60
.BI "\-T\fP, \fB\-\-tempdir" " directory"
67
takes a set of data files and packages them for use by ICU or
68
applications that use ICU. The typical reason to package files using
70
is to make their distribution easier.
73
supports a few different methods of packaging data that serve
82
In this mode, the different data files are bundled together as an
83
architecture-dependent file that can later be memory mapped for use by
84
ICU. Data packaged using this mode will be looked up under the ICU
85
data directory. Such packaging is easy to use for applications resource
86
bundles, for example, as long as the application can install the
87
packaged file in the ICU data directory.
89
Another packaging mode is the
93
mode, where the data files are compiled into a shared library. ICU
94
used to be able to dynamically load these shared libraries, but as of
95
ICU 2.0, such support has been removed. This mode is still useful for
96
two main purposes: to build ICU itself, as the ICU data is packaged as
97
a shared library by default; and to build resource bundles that are
98
linked to the application that uses them. Such resource bundles can
99
then be placed anywhere where the system's dynamic linker will be
100
looking for shared libraries, instead of being forced to live inside
101
the ICU data directory.
105
packaging mode is similar to dll or library, however it produces a
106
static library. Note that many platforms are not able to dynamically load
107
symbols from static object files, so for this reason
108
.BR udata_setAppData()
110
to install this data. As a convenience, pkgdata will build a C source file
111
and a header file. Given a data package named "\fIname\fP", in the output
112
directory will be created \fIname\fR.c and \fIname\fR.h with the single
113
function \fBudata_install_\fIname\fB(UErrorCode *err)\fR. Call this function
114
once early in the program. The error code returned is that of \fBudata_setAppData()\fP.
115
Subsequently, the application can access this data by passing "\fIname\fP" for the "path"
116
argument to functions such as \fBures_open()\fP.
124
mode which simply copies the data files instead of packaging
125
them as a single file or library. This mode is mainly intended to
126
provide support for building ICU before it is packaged as separate
127
small packages for distribution with operating systems such as Debian
128
GNU/Linux for example. Please refer to the packaging documentation in
129
the ICU source distribution for further information on the use of this
135
to do the packaging, and generates a makefile with rules to build
136
and package the correct data.
139
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
140
Print help about usage and exit.
142
.BR "\-v\fP, \fB\-\-verbose"
143
Display extra informative messages during execution.
145
.BR "\-c\fP, \fB\-\-copyright"
146
Include a copyright notice in the binary data.
148
.BI "\-C\fP, \fB\-\-comment" " comment"
149
Includes the specified
151
in the resulting data instead of the ICU copyright notice.
153
.BI "\-m\fP, \fB\-\-mode" " mode"
158
The different modes and their meaning are explained in the
160
section above. The valid mode names are
170
.BI "\-O\fP, \fB\-\-bldopt" " options"
171
Specify options for the builder. The builder is used internally by
173
to generate the correct packaged file. Such options include, but are
174
not limited to, setting variables used by
176
during the build of the packaged file.
178
.BI "\-p\fP, \fB\-\-name" " name"
179
Set the packaged file name to
181
This name is also used as the default entry point name.
183
.BI "\-e\fP, \fB\-\-entrypoint" " name"
184
Set the data entry point (used for linking against the data in a
185
shared library form) to
187
The default entry point name is the name set by the
188
.BI "\-n\fP, \fB\-\-name"
191
.BI "\-r\fP, \fB\-\-revision" " version"
192
Enable versioning of the shared library produced in
194
mode. The version number has the format
195
.I major\fP.\fIminor\fP.\fIpatchlevel
196
and all parts except for
198
are optional. If only
200
is supplied then the version is
203
for versioning purposes.
211
.BI "\-F\fP, \fB\-\-rebuild"
212
Force the rebuilding of all data and their repackaging.
214
.BI "\-k\fP, \fB\-\-clean"
215
Clean temporary files and other build residues.
217
.BI "\-I\fP, \fB\-\-install"
218
Install the packaged file (or all the files in the
220
mode). If the variable
222
is set it will be used for installation.
224
.BI "\-n\fP, \fB\-\-nooutput"
225
Do not produce any output but simply a list of affected files.
227
.BI "\-s\fP, \fB\-\-sourcedir" " source"
228
Set the source directory to
230
The default source directory is the current directory.
232
.BI "\-d\fP, \fB\-\-destdir" " destination"
233
Set the destination directory to
235
The default destination directory is the current directory.
237
.BI "\-T\fP, \fB\-\-tempdir" " directory"
238
Set the directory used to generate temporary files to
240
The default temporary directory is the same as the destination
243
.BI "\-d\fP, \fB\-\-destdir"
248
Copyright (C) 2000-2001 IBM, Inc. and others.
added
removed
source/tools/pkgdata/pkgdata.8.in
