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