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