Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/pkgdata.1 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
rev   line source
jpayne@68 1 .\" Hey, Emacs! This is -*-nroff-*- you know...
jpayne@68 2 .\"
jpayne@68 3 .\" pkgdata.1: manual page for the pkgdata utility
jpayne@68 4 .\"
jpayne@68 5 .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
jpayne@68 6 .\" License & terms of use: http://www.unicode.org/copyright.html
jpayne@68 7 .\" Copyright (C) 2000-2009 IBM, Inc. and others.
jpayne@68 8 .\"
jpayne@68 9 .\" Manual page by Yves Arrouye <yves@realnames.com>.
jpayne@68 10 .\" Modified by Michael Ow <mow@us.ibm.com>.
jpayne@68 11 .\"
jpayne@68 12 .TH PKGDATA 1 "6 February 2009" "ICU MANPAGE" "ICU 67.1 Manual"
jpayne@68 13 .SH NAME
jpayne@68 14 .B pkgdata
jpayne@68 15 \- package data for use by ICU
jpayne@68 16 .SH SYNOPSIS
jpayne@68 17 .B pkgdata
jpayne@68 18 [
jpayne@68 19 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68 20 ]
jpayne@68 21 [
jpayne@68 22 .BI "\-v\fP, \fB\-\-verbose"
jpayne@68 23 ]
jpayne@68 24 [
jpayne@68 25 .BR "\-c\fP, \fB\-\-copyright"
jpayne@68 26 |
jpayne@68 27 .BI "\-C\fP, \fB\-\-comment" " comment"
jpayne@68 28 ]
jpayne@68 29 [
jpayne@68 30 .BI "\-m\fP, \fB\-\-mode" " mode"
jpayne@68 31 ]
jpayne@68 32 .BI "\-p\fP, \fB\-\-name" " name"
jpayne@68 33 .BI "\-O\fP, \fB\-\-bldopt" " options"
jpayne@68 34 [
jpayne@68 35 .BI "\-e\fP, \fB\-\-entrypoint" " name"
jpayne@68 36 ]
jpayne@68 37 [
jpayne@68 38 .BI "\-r\fP, \fB\-\-revision" " version"
jpayne@68 39 ]
jpayne@68 40 [
jpayne@68 41 .BI "\-F\fP, \fB\-\-rebuild"
jpayne@68 42 ]
jpayne@68 43 [
jpayne@68 44 .BI "\-I\fP, \fB\-\-install"
jpayne@68 45 ]
jpayne@68 46 [
jpayne@68 47 .BI "\-s\fP, \fB\-\-sourcedir" " source"
jpayne@68 48 ]
jpayne@68 49 [
jpayne@68 50 .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68 51 ]
jpayne@68 52 [
jpayne@68 53 .BI "\-T\fP, \fB\-\-tempdir" " directory"
jpayne@68 54 ]
jpayne@68 55 [
jpayne@68 56 .IR file " .\|.\|."
jpayne@68 57 ]
jpayne@68 58 .SH DESCRIPTION
jpayne@68 59 .B pkgdata
jpayne@68 60 takes a set of data files and packages them for use by ICU or
jpayne@68 61 applications that use ICU. The typical reason to package files using
jpayne@68 62 .B pkgdata
jpayne@68 63 is to make their distribution easier and their loading by ICU faster
jpayne@68 64 and less consuming of limited system resources such as file
jpayne@68 65 descriptors.
jpayne@68 66 Packaged data also allow applications to be distributed with fewer
jpayne@68 67 resource files, or even with none at all if they link against the
jpayne@68 68 packaged data directly.
jpayne@68 69 .PP
jpayne@68 70 .B pkgdata
jpayne@68 71 supports a few different methods of packaging data that serve
jpayne@68 72 different purposes.
jpayne@68 73 .PP
jpayne@68 74 The default packaging
jpayne@68 75 .I mode
jpayne@68 76 is
jpayne@68 77 .BR common ,
jpayne@68 78 or
jpayne@68 79 .BR archive .
jpayne@68 80 In this mode, the different data files are bundled together as an
jpayne@68 81 architecture-dependent file that can later be memory mapped for use by
jpayne@68 82 ICU. Data packaged using this mode will be looked up under the ICU
jpayne@68 83 data directory. Such packaging is easy to use for applications resource
jpayne@68 84 bundles, for example, as long as the application can install the
jpayne@68 85 packaged file in the ICU data directory.
jpayne@68 86 .PP
jpayne@68 87 Another packaging mode is the
jpayne@68 88 .BR dll ,
jpayne@68 89 or
jpayne@68 90 .BR library ,
jpayne@68 91 mode, where the data files are compiled into a shared library. ICU
jpayne@68 92 used to be able to dynamically load these shared libraries, but as of
jpayne@68 93 ICU 2.0, such support has been removed. This mode is still useful for
jpayne@68 94 two main purposes: to build ICU itself, as the ICU data is packaged as
jpayne@68 95 a shared library by default; and to build resource bundles that are
jpayne@68 96 linked to the application that uses them. Such resource bundles can
jpayne@68 97 then be placed anywhere where the system's dynamic linker will be
jpayne@68 98 looking for shared libraries, instead of being forced to live inside
jpayne@68 99 the ICU data directory.
jpayne@68 100 .PP
jpayne@68 101 The
jpayne@68 102 .BR static
jpayne@68 103 packaging mode is similar to the shared library one except that it
jpayne@68 104 produces a static library.
jpayne@68 105 .\" Note that many platforms are not able to
jpayne@68 106 .\" dynamically load symbols from static object files, so for this reason
jpayne@68 107 .\" .BR udata_setAppData()
jpayne@68 108 .\" must be called
jpayne@68 109 .\" to install this data. As a convenience, pkgdata will build a C source file
jpayne@68 110 .\" and a header file. Given a data package named
jpayne@68 111 .\" .IR name, in the output
jpayne@68 112 .\" directory will be created
jpayne@68 113 .\" .IR name .c
jpayne@68 114 .\" and
jpayne@68 115 .\" .IR name .h with the single
jpayne@68 116 .\" function
jpayne@68 117 .\" .BR "udata_install_\fcIname\fB(UErrorCode *err)" ,
jpayne@68 118 .\" where
jpayne@68 119 .\" .I cname
jpayne@68 120 .\" is
jpayne@68 121 .\" .I name
jpayne@68 122 .\" turned into a valid C identifier.
jpayne@68 123 .\" The application need to call this function once. The error code returned
jpayne@68 124 .\" is that of
jpayne@68 125 .\" .BR udata_setAppData() .
jpayne@68 126 .\" .PP
jpayne@68 127 .\" Data pakackaged in a library, whether shared or static,
jpayne@68 128 .\" Subsequently, the application can access this data by passing
jpayne@68 129 .\" .I name for the
jpayne@68 130 .\" .I path
jpayne@68 131 .\" rgument to functions such as
jpayne@68 132 .\" .BR Bures_open() .
jpayne@68 133 .PP
jpayne@68 134 Finally,
jpayne@68 135 .B pkgdata
jpayne@68 136 supports a
jpayne@68 137 .B files
jpayne@68 138 mode which simply copies the data files instead of packaging
jpayne@68 139 them as a single file or library. This mode is mainly intended to
jpayne@68 140 provide support for building ICU before it is packaged as separate
jpayne@68 141 small packages for distribution with operating systems such as Debian
jpayne@68 142 GNU/Linux for example. Please refer to the packaging documentation in
jpayne@68 143 the ICU source distribution for further information on the use of this
jpayne@68 144 mode.
jpayne@68 145 .PP
jpayne@68 146 .B pkgdata
jpayne@68 147 builds, packages, installs, or cleans the appropriate data based on the options given
jpayne@68 148 without the need to call GNU
jpayne@68 149 .BR make
jpayne@68 150 anymore.
jpayne@68 151 .SH OPTIONS
jpayne@68 152 .TP
jpayne@68 153 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68 154 Print help about usage and exit.
jpayne@68 155 .TP
jpayne@68 156 .BR "\-v\fP, \fB\-\-verbose"
jpayne@68 157 Display extra informative messages during execution.
jpayne@68 158 .TP
jpayne@68 159 .BR "\-c\fP, \fB\-\-copyright"
jpayne@68 160 Include a copyright notice in the binary data.
jpayne@68 161 .TP
jpayne@68 162 .BI "\-C\fP, \fB\-\-comment" " comment"
jpayne@68 163 Includes the specified
jpayne@68 164 .I comment
jpayne@68 165 in the resulting data instead of the ICU copyright notice.
jpayne@68 166 .TP
jpayne@68 167 .BI "\-m\fP, \fB\-\-mode" " mode"
jpayne@68 168 Set the packaging
jpayne@68 169 .I mode
jpayne@68 170 to be used by
jpayne@68 171 .BR pkgdata .
jpayne@68 172 The different modes and their meaning are explained in the
jpayne@68 173 .B DESCRIPTION
jpayne@68 174 section above. The valid mode names are
jpayne@68 175 .BR common
jpayne@68 176 (or
jpayne@68 177 .BR archive ),
jpayne@68 178 .BR dll
jpayne@68 179 (or
jpayne@68 180 .BR library ),
jpayne@68 181 and
jpayne@68 182 .BR files .
jpayne@68 183 .TP
jpayne@68 184 .BI "\-O\fP, \fB\-\-bldopt" " options"
jpayne@68 185 Specify options for the builder. The builder is used internally by
jpayne@68 186 .B pkgdata
jpayne@68 187 to generate the correct packaged file. Such options include, but are
jpayne@68 188 not limited to, setting variables used by
jpayne@68 189 .BR make (1)
jpayne@68 190 during the build of the packaged file. Note: If
jpayne@68 191 .BR icu-config
jpayne@68 192 is available, then this option is not needed.
jpayne@68 193 .TP
jpayne@68 194 .BI "\-p\fP, \fB\-\-name" " name"
jpayne@68 195 Set the packaged file name to
jpayne@68 196 .IR name .
jpayne@68 197 This name is also used as the default entry point name after having
jpayne@68 198 been turned into a valid C identifier.
jpayne@68 199 .TP
jpayne@68 200 .BI "\-e\fP, \fB\-\-entrypoint" " name"
jpayne@68 201 Set the data entry point (used for linking against the data in a
jpayne@68 202 shared library form) to
jpayne@68 203 .IR name .
jpayne@68 204 The default entry point name is the name set by the
jpayne@68 205 .BI "\-n\fP, \fB\-\-name"
jpayne@68 206 option.
jpayne@68 207 .TP
jpayne@68 208 .BI "\-r\fP, \fB\-\-revision" " version"
jpayne@68 209 Enable versioning of the shared library produced in
jpayne@68 210 .BR dll ,
jpayne@68 211 or
jpayne@68 212 .BR library ,
jpayne@68 213 mode. The version number has the format
jpayne@68 214 .I major\fP.\fIminor\fP.\fIpatchlevel
jpayne@68 215 and all parts except for
jpayne@68 216 .I major
jpayne@68 217 are optional. If only
jpayne@68 218 .I major
jpayne@68 219 is supplied then the version is
jpayne@68 220 assumed to be
jpayne@68 221 .IR major .0
jpayne@68 222 for versioning purposes.
jpayne@68 223 .TP
jpayne@68 224 .BI "\-F\fP, \fB\-\-rebuild"
jpayne@68 225 Force the rebuilding of all data and their repackaging.
jpayne@68 226 .TP
jpayne@68 227 .BI "\-I\fP, \fB\-\-install"
jpayne@68 228 Install the packaged file (or all the files in the
jpayne@68 229 .B files
jpayne@68 230 mode). If the variable
jpayne@68 231 .B DESTDIR
jpayne@68 232 is set it will be used for installation.
jpayne@68 233 .TP
jpayne@68 234 .BI "\-s\fP, \fB\-\-sourcedir" " source"
jpayne@68 235 Set the source directory to
jpayne@68 236 .IR source .
jpayne@68 237 The default source directory is the current directory.
jpayne@68 238 .TP
jpayne@68 239 .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68 240 Set the destination directory to
jpayne@68 241 .IR destination .
jpayne@68 242 The default destination directory is the current directory.
jpayne@68 243 .TP
jpayne@68 244 .BI "\-T\fP, \fB\-\-tempdir" " directory"
jpayne@68 245 Set the directory used to generate temporary files to
jpayne@68 246 .IR directory .
jpayne@68 247 The default temporary directory is the same as the destination
jpayne@68 248 directory
jpayne@68 249 as set by the
jpayne@68 250 .BI "\-d\fP, \fB\-\-destdir"
jpayne@68 251 option.
jpayne@68 252 .SH AUTHORS
jpayne@68 253 Steven Loomis
jpayne@68 254 .br
jpayne@68 255 Yves Arrouye
jpayne@68 256 .SH VERSION
jpayne@68 257 67.1
jpayne@68 258 .SH COPYRIGHT
jpayne@68 259 Copyright (C) 2000-2009 IBM, Inc. and others.
jpayne@68 260