intl/icu/source/tools/icupkg/icupkg.8.in@fc2d59ddac77
intl/icu/source/tools/icupkg/icupkg.8.in
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
2 .\"
3 .\" icupkg.8: manual page for the icupkg utility
4 .\"
5 .\" Copyright (C) 2000-2006 IBM, Inc. and others.
6 .\"
7 .TH ICUPKG 8 "18 August 2006" "ICU MANPAGE" "ICU @VERSION@ Manual"
8 .SH NAME
9 .B icupkg
10 \- extract or modify an ICU
11 .B .dat
12 archive
13 .SH SYNOPSIS
14 .B icupkg
15 [
16 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
17 ]
18 [
19 .BR "\-tl\fP, \fB\-\-type" " l"
20 |
21 .BR "\-tb\fP, \fB\-\-type" " b"
22 |
23 .BR "\-te\fP, \fB\-\-type" " e"
24 ]
25 [
26 .BR "\-c\fP, \fB\-\-copyright"
27 |
28 .BI "\-C\fP, \fB\-\-comment" " comment"
29 ]
30 [
31 .BI "\-a\fP, \fB\-\-add" " list"
32 ]
33 [
34 .BI "\-r\fP, \fB\-\-remove" " list"
35 ]
36 [
37 .BI "\-x\fP, \fB\-\-extract" " list"
38 ]
39 [
40 .BI "\-l\fP, \fB\-\-list"
41 ]
42 [
43 .BI "\-s\fP, \fB\-\-sourcedir" " source"
44 ]
45 [
46 .BI "\-d\fP, \fB\-\-destdir" " destination"
47 ]
48 [
49 .BI "\-w\fP, \fB\-\-writepkg"
50 ]
51 [
52 .BI "\-m\fP, \fB\-\-matchmode" " mode"
53 ]
54 .IR infilename
55 [
56 .BI "outfilename"
57 ]
58 .SH DESCRIPTION
59 .B icupkg
60 reads the input ICU
61 .B .dat
62 package file, modify it according to the options,
63 swap it to the desired platform properties (charset & endianness),
64 and optionally write the resulting ICU
65 .B .dat
66 package to the output file.
67 Items are removed, then added, then extracted and listed.
68 An ICU
69 .B .dat
70 package is written if items are removed or added,
71 or if the input and output filenames differ,
72 or if the
73 .BR "\-w\fP, \fB\-\-writepkg"
74 option is set.
75 .PP
76 If the input filename is "new" then an empty package is created.
77 If the output filename is missing, then it is automatically generated
78 from the input filename. If the input filename ends with an l, b, or e
79 matching its platform properties, then the output filename will
80 contain the letter from the
81 .BI "\-t\fP, \fB\-\-type"
82 option.
83 .PP
84 This tool can also be used to just swap a single ICU data file, replacing the
85 former icuswap tool. For this mode, provide the infilename (and optional
86 outfilename) for a non-package ICU data file.
87 Allowed options include
88 .BI "\-t\fP, \fB\-w\fP, \fB\-s\fP"
89 and
90 .BI \-d
91 .
92 The filenames can be absolute, or relative to the source/dest dir paths.
93 Other options are not allowed in this mode.
94 .SH OPTIONS
95 .TP
96 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
97 Print help about usage and exit.
98 .TP
99 .BI "\-tl\fP, \fB\-\-type" " l"
100 Output for little-endian/ASCII charset family.
101 The output type defaults to the input type.
102 .TP
103 .BI "\-tb\fP, \fB\-\-type" " b"
104 Output for big-endian/ASCII charset family.
105 The output type defaults to the input type.
106 .TP
107 .BI "\-te\fP, \fB\-\-type" " e"
108 Output for big-endian/EBCDIC charset family.
109 The output type defaults to the input type.
110 .TP
111 .BR \-c\fP, \fB\-\-copyright
112 Include the ICU copyright notice in the resulting data.
113 .TP
114 .BI "\-C\fP, \fB\-\-comment" " comment"
115 Include the specified
116 .I comment
117 in the resulting data instead of the ICU copyright notice.
118 .TP
119 .BI "\-a\fP, \fB\-\-add" " list"
120 Add items from the
121 .I list
122 to the package. The list can be a single filename with a
123 .B .txt
124 file extension containing a list of item filenames, or an ICU
125 .B .dat
126 package filename.
127 .TP
128 .BI "\-r\fP, \fB\-\-remove" " list"
129 Remove items from the
130 .I list
131 from the package. The list can be a single filename with a
132 .B .txt
133 file extension containing a list of item filenames, or an ICU
134 .B .dat
135 package filename.
136 .TP
137 .BI "\-x\fP, \fB\-\-extract" " list"
138 Extract items from the
139 .I list
140 from the package. The list can be a single filename with a
141 .B .txt
142 file extension containing a list of item filenames, or an ICU
143 .B .dat
144 package filename.
145 .TP
146 .BI "\-m\fP, \fB\-\-matchmode" " mode"
147 Set the matching mode for item names with wildcards.
148 .TP
149 .BI "\-s\fP, \fB\-\-sourcedir" " source"
150 Set the source directory to
151 .IR source .
152 The default source directory is the current directory.
153 .TP
154 .BI "\-d\fP, \fB\-\-destdir" " destination"
155 Set the destination directory to
156 .IR destination .
157 The default destination directory is the current directory.
158 .TP
159 .BI "\-l\fP, \fB\-\-list"
160 List the package items to stdout (after modifying the package).
161 .SH LIST FILE SYNTAX
162 Items are listed on one or more lines and separated by whitespace (space+tab).
163 Comments begin with
164 .B #
165 and are ignored. Empty lines are ignored. Lines where the first non-whitespace
166 character is one of "%&'()*+,-./:;<=>?_ are also ignored
167 to reserve for future syntax.
168 .PP
169 Items for removal or extraction may contain a single
170 .B *
171 wildcard character. The
172 .B *
173 matches zero or more characters. If
174 .BI "\-m\fP, \fB\-\-matchmode" " noslash"
175 is set, then the
176 .B *
177 character does not match the
178 .B /
179 character.
180 .PP
181 Items must be listed relative to the package, and the
182 .B "\fB\-\-sourcedir"
183 or the
184 .B "\fB\-\-destdir"
185 path will be prepended. The paths are only prepended to item
186 filenames while adding or extracting items, not to ICU .dat package or list
187 filenames.
188 .PP
189 Paths may contain
190 .B /
191 instead of the platform's file separator character and are converted as
192 appropriate.
193 .SH AUTHORS
194 Markus Scherer
195 .br
196 George Rhoten
197 .SH VERSION
198 1.0
199 .SH COPYRIGHT
200 Copyright (C) 2006 IBM, Inc. and others.
201 .SH SEE ALSO
202 .BR pkgdata (1)
203 .BR genrb (1)
