186 lines
4.8 KiB
Groff
186 lines
4.8 KiB
Groff
|
.\" Hey, Emacs! This is -*-nroff-*- you know...
|
||
|
|
.\"
|
||
|
|
.\" pkgdata.8: manual page for the pkgdata utility
|
||
|
|
.\"
|
||
|
|
.\" Copyright (C) 2000 IBM, Inc. and others.
|
||
|
|
.\"
|
||
|
|
.\" Manual page by Yves Arrouye <yves@realnames.com>.
|
||
|
|
.\"
|
||
|
|
.TH PKGDATA 8 "20 December 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
|
||
|
|
.SH NAME
|
||
|
|
.B pkgdata
|
||
|
|
\- package data for use by ICU
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.B pkgdata
|
||
|
|
[
|
||
|
|
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BR "\-c\fP, \fB\-\-copyright"
|
||
|
|
|
|
||
|
|
.BI "\-C\fP, \fB\-\-comment" " comment"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-m\fP, \fB\-\-mode" " mode"
|
||
|
|
]
|
||
|
|
.BI "\-p\fP, \fB\-\-name" " name"
|
||
|
|
.BI "\-O\fP, \fB\-\-bldopt" " options"
|
||
|
|
[
|
||
|
|
.BI "\-s\fP, \fB\-\-sourcedir" " source"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-d\fP, \fB\-\-destdir" " destination"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-T\fP, \fB\-\-tempdir" " directory"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-v\fP, \fB\-\-verbose"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-p\fP, \fB\-\-name" " name"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-e\fP, \fB\-\-entrypoint" " name"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-V\fP, \fB\-\-version" " version"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-F\fP, \fB\-\-rebuild"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-k\fP, \fB\-\-clean"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-I\fP, \fB\-\-install"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.BI "\-n\fP, \fB\-\-nooutput"
|
||
|
|
]
|
||
|
|
[
|
||
|
|
.IR file " .\|.\|."
|
||
|
|
]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.B pkgdata
|
||
|
|
takes a set of data files and packages them for use by ICU or
|
||
|
|
applications that use ICU. The typical reason to package files using
|
||
|
|
.B pkgdata
|
||
|
|
is to make their distribution easier.
|
||
|
|
.PP
|
||
|
|
.B pkgdata
|
||
|
|
supports a few different methods of packaging data that serve
|
||
|
|
different purposes.
|
||
|
|
.PP
|
||
|
|
The default packaging
|
||
|
|
.I mode
|
||
|
|
is
|
||
|
|
.IR common .
|
||
|
|
In this mode, the different data files are bundled together as an
|
||
|
|
architecture-dependent file that can later be memory mapped for use by
|
||
|
|
ICU. Data packaged using this mode will be looked up under the ICU
|
||
|
|
data directory (see section
|
||
|
|
.B ENVIRONMENT
|
||
|
|
below). Such packaging is easy to use for applications resource
|
||
|
|
bundles, for example, as long as the application can install the
|
||
|
|
packaged file in the ICU data directory.
|
||
|
|
.PP
|
||
|
|
Another packaging mode is the
|
||
|
|
.I dll
|
||
|
|
mode, where the data files are compiled into a shared library. ICU
|
||
|
|
used to be able to dynamically load these shared libraries, but as of
|
||
|
|
ICU 2.0, such support has been removed. This mode is still useful for
|
||
|
|
two main purposes: to build ICU itself, as the ICU data is packaged as
|
||
|
|
a shared library by default; and to build resource bundles that are
|
||
|
|
linked to the application that uses them. Such resource bundles can
|
||
|
|
then be placed anywhere where the system's dynamic linker will be
|
||
|
|
looking for shared libraries, instead of being forced to live inside
|
||
|
|
the ICU data directory.
|
||
|
|
.PP
|
||
|
|
Finally,
|
||
|
|
.B pkgdata
|
||
|
|
supports a
|
||
|
|
.I files
|
||
|
|
mode which simply moves the data files around instead of packaging
|
||
|
|
them as a single file or library. This mode is mainly intended to
|
||
|
|
provide support for building ICU before it is packaged as separate
|
||
|
|
small packages for distribution with operating systems such as Debian
|
||
|
|
GNU/Linux for example. Please refer to the packaging documentation in
|
||
|
|
the ICU source distribution for further information on the use of this
|
||
|
|
mode.
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.BR \-h\fP, \fB\-?\fP, \fB\-\-help
|
||
|
|
Print help about usage and exit.
|
||
|
|
.TP
|
||
|
|
.BR \-c\fP, \fB\-\-copyright
|
||
|
|
Include a copyright notice in the binary data.
|
||
|
|
.TP
|
||
|
|
.BI "\-C\fP, \fB\-\-comment" " comment"
|
||
|
|
Includes the specified
|
||
|
|
.I comment
|
||
|
|
in the resulting data instead of the ICU copyright notice.
|
||
|
|
.TP
|
||
|
|
.BI "\-m\fP, \fB\-\-mode" " mode"
|
||
|
|
Set the packaging
|
||
|
|
.I mode
|
||
|
|
to be used by
|
||
|
|
.BR pkgdata .
|
||
|
|
The different modes and their meaning are explained in the
|
||
|
|
.B DESCRIPTION
|
||
|
|
section above.
|
||
|
|
.TP
|
||
|
|
.BI "\-O\fP, \fB\-\-bldopt" " options"
|
||
|
|
Specify options for the builder. The builder is used internally by
|
||
|
|
.B pkgdata
|
||
|
|
to generate the correct packaged file. Such options include, but are
|
||
|
|
not limited to, setting variables used by
|
||
|
|
.BR make (1)
|
||
|
|
during the build of the packaged file.
|
||
|
|
.TP
|
||
|
|
.BI "\-n\fP, \fB\-\-name" " name"
|
||
|
|
Set the packaged file name to
|
||
|
|
.IR name .
|
||
|
|
This name is also used as the default entry point name.
|
||
|
|
.TP
|
||
|
|
.BI "\-e\fP, \fB\-\-entrypoint" " name"
|
||
|
|
Set the data entry point (used for linking against the data in a
|
||
|
|
shared library form) to
|
||
|
|
.IR name .
|
||
|
|
The default entry point name is the name set by the
|
||
|
|
.BI "\-n\fP, \fB\-\-name"
|
||
|
|
option.
|
||
|
|
.TP
|
||
|
|
.BI "\-s\fP, \fB\-\-sourcedir" " source"
|
||
|
|
Set the source directory to
|
||
|
|
.IR source .
|
||
|
|
The default source directory is the current directory.
|
||
|
|
.TP
|
||
|
|
.BI "\-d\fP, \fB\-\-destdir" " destination"
|
||
|
|
Set the destination directory to
|
||
|
|
.IR destination .
|
||
|
|
The default destination directory is the current directory.
|
||
|
|
.TP
|
||
|
|
.BI "\-T\fP, \fB\-\-tempdir" " directory"
|
||
|
|
Set the directory used to generate temporary files to
|
||
|
|
.IR directory .
|
||
|
|
The default temporary directory is the same as the destination
|
||
|
|
directory
|
||
|
|
as set by the
|
||
|
|
.BI "\-d\fP, \fB\-\-destdir"
|
||
|
|
option.
|
||
|
|
.SH ENVIRONMENT
|
||
|
|
.TP 10
|
||
|
|
.B ICU_DATA
|
||
|
|
Specifies the directory containing ICU data. Defaults to
|
||
|
|
.BR @thedatadir@/icu/@VERSION@/ .
|
||
|
|
Some tools in ICU depend on the presence of the trailing slash. It is thus
|
||
|
|
important to make sure that it is present if
|
||
|
|
.B ICU_DATA
|
||
|
|
is set.
|
||
|
|
.SH VERSION
|
||
|
|
@VERSION@
|
||
|
|
.SH COPYRIGHT
|
||
|
|
Copyright (C) 2000-2001 IBM, Inc. and others.
|
||
|
|
|