1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/icupkg/icupkg.8.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,204 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" icupkg.8: manual page for the icupkg utility
1.7 +.\"
1.8 +.\" Copyright (C) 2000-2006 IBM, Inc. and others.
1.9 +.\"
1.10 +.TH ICUPKG 8 "18 August 2006" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.11 +.SH NAME
1.12 +.B icupkg
1.13 +\- extract or modify an ICU
1.14 +.B .dat
1.15 +archive
1.16 +.SH SYNOPSIS
1.17 +.B icupkg
1.18 +[
1.19 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.20 +]
1.21 +[
1.22 +.BR "\-tl\fP, \fB\-\-type" " l"
1.23 +|
1.24 +.BR "\-tb\fP, \fB\-\-type" " b"
1.25 +|
1.26 +.BR "\-te\fP, \fB\-\-type" " e"
1.27 +]
1.28 +[
1.29 +.BR "\-c\fP, \fB\-\-copyright"
1.30 +|
1.31 +.BI "\-C\fP, \fB\-\-comment" " comment"
1.32 +]
1.33 +[
1.34 +.BI "\-a\fP, \fB\-\-add" " list"
1.35 +]
1.36 +[
1.37 +.BI "\-r\fP, \fB\-\-remove" " list"
1.38 +]
1.39 +[
1.40 +.BI "\-x\fP, \fB\-\-extract" " list"
1.41 +]
1.42 +[
1.43 +.BI "\-l\fP, \fB\-\-list"
1.44 +]
1.45 +[
1.46 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.47 +]
1.48 +[
1.49 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.50 +]
1.51 +[
1.52 +.BI "\-w\fP, \fB\-\-writepkg"
1.53 +]
1.54 +[
1.55 +.BI "\-m\fP, \fB\-\-matchmode" " mode"
1.56 +]
1.57 +.IR infilename
1.58 +[
1.59 +.BI "outfilename"
1.60 +]
1.61 +.SH DESCRIPTION
1.62 +.B icupkg
1.63 +reads the input ICU
1.64 +.B .dat
1.65 +package file, modify it according to the options,
1.66 +swap it to the desired platform properties (charset & endianness),
1.67 +and optionally write the resulting ICU
1.68 +.B .dat
1.69 +package to the output file.
1.70 +Items are removed, then added, then extracted and listed.
1.71 +An ICU
1.72 +.B .dat
1.73 +package is written if items are removed or added,
1.74 +or if the input and output filenames differ,
1.75 +or if the
1.76 +.BR "\-w\fP, \fB\-\-writepkg"
1.77 +option is set.
1.78 +.PP
1.79 +If the input filename is "new" then an empty package is created.
1.80 +If the output filename is missing, then it is automatically generated
1.81 +from the input filename. If the input filename ends with an l, b, or e
1.82 +matching its platform properties, then the output filename will
1.83 +contain the letter from the
1.84 +.BI "\-t\fP, \fB\-\-type"
1.85 +option.
1.86 +.PP
1.87 +This tool can also be used to just swap a single ICU data file, replacing the
1.88 +former icuswap tool. For this mode, provide the infilename (and optional
1.89 +outfilename) for a non-package ICU data file.
1.90 +Allowed options include
1.91 +.BI "\-t\fP, \fB\-w\fP, \fB\-s\fP"
1.92 +and
1.93 +.BI \-d
1.94 +.
1.95 +The filenames can be absolute, or relative to the source/dest dir paths.
1.96 +Other options are not allowed in this mode.
1.97 +.SH OPTIONS
1.98 +.TP
1.99 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.100 +Print help about usage and exit.
1.101 +.TP
1.102 +.BI "\-tl\fP, \fB\-\-type" " l"
1.103 +Output for little-endian/ASCII charset family.
1.104 +The output type defaults to the input type.
1.105 +.TP
1.106 +.BI "\-tb\fP, \fB\-\-type" " b"
1.107 +Output for big-endian/ASCII charset family.
1.108 +The output type defaults to the input type.
1.109 +.TP
1.110 +.BI "\-te\fP, \fB\-\-type" " e"
1.111 +Output for big-endian/EBCDIC charset family.
1.112 +The output type defaults to the input type.
1.113 +.TP
1.114 +.BR \-c\fP, \fB\-\-copyright
1.115 +Include the ICU copyright notice in the resulting data.
1.116 +.TP
1.117 +.BI "\-C\fP, \fB\-\-comment" " comment"
1.118 +Include the specified
1.119 +.I comment
1.120 +in the resulting data instead of the ICU copyright notice.
1.121 +.TP
1.122 +.BI "\-a\fP, \fB\-\-add" " list"
1.123 +Add items from the
1.124 +.I list
1.125 +to the package. The list can be a single filename with a
1.126 +.B .txt
1.127 +file extension containing a list of item filenames, or an ICU
1.128 +.B .dat
1.129 +package filename.
1.130 +.TP
1.131 +.BI "\-r\fP, \fB\-\-remove" " list"
1.132 +Remove items from the
1.133 +.I list
1.134 +from the package. The list can be a single filename with a
1.135 +.B .txt
1.136 +file extension containing a list of item filenames, or an ICU
1.137 +.B .dat
1.138 +package filename.
1.139 +.TP
1.140 +.BI "\-x\fP, \fB\-\-extract" " list"
1.141 +Extract items from the
1.142 +.I list
1.143 +from the package. The list can be a single filename with a
1.144 +.B .txt
1.145 +file extension containing a list of item filenames, or an ICU
1.146 +.B .dat
1.147 +package filename.
1.148 +.TP
1.149 +.BI "\-m\fP, \fB\-\-matchmode" " mode"
1.150 +Set the matching mode for item names with wildcards.
1.151 +.TP
1.152 +.BI "\-s\fP, \fB\-\-sourcedir" " source"
1.153 +Set the source directory to
1.154 +.IR source .
1.155 +The default source directory is the current directory.
1.156 +.TP
1.157 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.158 +Set the destination directory to
1.159 +.IR destination .
1.160 +The default destination directory is the current directory.
1.161 +.TP
1.162 +.BI "\-l\fP, \fB\-\-list"
1.163 +List the package items to stdout (after modifying the package).
1.164 +.SH LIST FILE SYNTAX
1.165 +Items are listed on one or more lines and separated by whitespace (space+tab).
1.166 +Comments begin with
1.167 +.B #
1.168 +and are ignored. Empty lines are ignored. Lines where the first non-whitespace
1.169 +character is one of "%&'()*+,-./:;<=>?_ are also ignored
1.170 +to reserve for future syntax.
1.171 +.PP
1.172 +Items for removal or extraction may contain a single
1.173 +.B *
1.174 +wildcard character. The
1.175 +.B *
1.176 +matches zero or more characters. If
1.177 +.BI "\-m\fP, \fB\-\-matchmode" " noslash"
1.178 +is set, then the
1.179 +.B *
1.180 +character does not match the
1.181 +.B /
1.182 +character.
1.183 +.PP
1.184 +Items must be listed relative to the package, and the
1.185 +.B "\fB\-\-sourcedir"
1.186 +or the
1.187 +.B "\fB\-\-destdir"
1.188 +path will be prepended. The paths are only prepended to item
1.189 +filenames while adding or extracting items, not to ICU .dat package or list
1.190 +filenames.
1.191 +.PP
1.192 +Paths may contain
1.193 +.B /
1.194 +instead of the platform's file separator character and are converted as
1.195 +appropriate.
1.196 +.SH AUTHORS
1.197 +Markus Scherer
1.198 +.br
1.199 +George Rhoten
1.200 +.SH VERSION
1.201 +1.0
1.202 +.SH COPYRIGHT
1.203 +Copyright (C) 2006 IBM, Inc. and others.
1.204 +.SH SEE ALSO
1.205 +.BR pkgdata (1)
1.206 +.BR genrb (1)
1.207 +
