michael@0: .\" Hey, Emacs! This is -*-nroff-*- you know...
michael@0: .\"
michael@0: .\" icupkg.8: manual page for the icupkg utility
michael@0: .\"
michael@0: .\" Copyright (C) 2000-2006 IBM, Inc. and others.
michael@0: .\"
michael@0: .TH ICUPKG 8 "18 August 2006" "ICU MANPAGE" "ICU @VERSION@ Manual"
michael@0: .SH NAME
michael@0: .B icupkg
michael@0: \- extract or modify an ICU
michael@0: .B .dat
michael@0: archive
michael@0: .SH SYNOPSIS
michael@0: .B icupkg
michael@0: [
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: ]
michael@0: [
michael@0: .BR "\-tl\fP, \fB\-\-type" " l"
michael@0: |
michael@0: .BR "\-tb\fP, \fB\-\-type" " b"
michael@0: |
michael@0: .BR "\-te\fP, \fB\-\-type" " e"
michael@0: ]
michael@0: [
michael@0: .BR "\-c\fP, \fB\-\-copyright"
michael@0: |
michael@0: .BI "\-C\fP, \fB\-\-comment" " comment"
michael@0: ]
michael@0: [
michael@0: .BI "\-a\fP, \fB\-\-add" " list"
michael@0: ]
michael@0: [
michael@0: .BI "\-r\fP, \fB\-\-remove" " list"
michael@0: ]
michael@0: [
michael@0: .BI "\-x\fP, \fB\-\-extract" " list"
michael@0: ]
michael@0: [
michael@0: .BI "\-l\fP, \fB\-\-list"
michael@0: ]
michael@0: [
michael@0: .BI "\-s\fP, \fB\-\-sourcedir" " source"
michael@0: ]
michael@0: [
michael@0: .BI "\-d\fP, \fB\-\-destdir" " destination"
michael@0: ]
michael@0: [
michael@0: .BI "\-w\fP, \fB\-\-writepkg"
michael@0: ]
michael@0: [
michael@0: .BI "\-m\fP, \fB\-\-matchmode" " mode"
michael@0: ]
michael@0: .IR infilename
michael@0: [
michael@0: .BI "outfilename"
michael@0: ]
michael@0: .SH DESCRIPTION
michael@0: .B icupkg
michael@0: reads the input ICU
michael@0: .B .dat
michael@0: package file, modify it according to the options,
michael@0: swap it to the desired platform properties (charset & endianness),
michael@0: and optionally write the resulting ICU
michael@0: .B .dat
michael@0: package to the output file.
michael@0: Items are removed, then added, then extracted and listed.
michael@0: An ICU
michael@0: .B .dat
michael@0: package is written if items are removed or added,
michael@0: or if the input and output filenames differ,
michael@0: or if the
michael@0: .BR "\-w\fP, \fB\-\-writepkg"
michael@0: option is set.
michael@0: .PP
michael@0: If the input filename is "new" then an empty package is created.
michael@0: If the output filename is missing, then it is automatically generated
michael@0: from the input filename. If the input filename ends with an l, b, or e
michael@0: matching its platform properties, then the output filename will
michael@0: contain the letter from the
michael@0: .BI "\-t\fP, \fB\-\-type"
michael@0: option.
michael@0: .PP
michael@0: This tool can also be used to just swap a single ICU data file, replacing the
michael@0: former icuswap tool. For this mode, provide the infilename (and optional
michael@0: outfilename) for a non-package ICU data file.
michael@0: Allowed options include
michael@0: .BI "\-t\fP, \fB\-w\fP, \fB\-s\fP"
michael@0: and
michael@0: .BI \-d
michael@0: .
michael@0: The filenames can be absolute, or relative to the source/dest dir paths.
michael@0: Other options are not allowed in this mode.
michael@0: .SH OPTIONS
michael@0: .TP
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: Print help about usage and exit.
michael@0: .TP
michael@0: .BI "\-tl\fP, \fB\-\-type" " l"
michael@0: Output for little-endian/ASCII charset family.
michael@0: The output type defaults to the input type.
michael@0: .TP
michael@0: .BI "\-tb\fP, \fB\-\-type" " b"
michael@0: Output for big-endian/ASCII charset family.
michael@0: The output type defaults to the input type.
michael@0: .TP
michael@0: .BI "\-te\fP, \fB\-\-type" " e"
michael@0: Output for big-endian/EBCDIC charset family.
michael@0: The output type defaults to the input type.
michael@0: .TP
michael@0: .BR \-c\fP, \fB\-\-copyright
michael@0: Include the ICU copyright notice in the resulting data.
michael@0: .TP
michael@0: .BI "\-C\fP, \fB\-\-comment" " comment"
michael@0: Include the specified
michael@0: .I comment
michael@0: in the resulting data instead of the ICU copyright notice. 
michael@0: .TP
michael@0: .BI "\-a\fP, \fB\-\-add" " list"
michael@0: Add items from the
michael@0: .I list
michael@0: to the package. The list can be a single filename with a
michael@0: .B .txt
michael@0: file extension containing a list of item filenames, or an ICU
michael@0: .B .dat
michael@0: package filename.
michael@0: .TP
michael@0: .BI "\-r\fP, \fB\-\-remove" " list"
michael@0: Remove items from the
michael@0: .I list
michael@0: from the package. The list can be a single filename with a
michael@0: .B .txt
michael@0: file extension containing a list of item filenames, or an ICU
michael@0: .B .dat
michael@0: package filename.
michael@0: .TP
michael@0: .BI "\-x\fP, \fB\-\-extract" " list"
michael@0: Extract items from the
michael@0: .I list
michael@0: from the package. The list can be a single filename with a
michael@0: .B .txt
michael@0: file extension containing a list of item filenames, or an ICU
michael@0: .B .dat
michael@0: package filename.
michael@0: .TP
michael@0: .BI "\-m\fP, \fB\-\-matchmode" " mode"
michael@0: Set the matching mode for item names with wildcards.
michael@0: .TP
michael@0: .BI "\-s\fP, \fB\-\-sourcedir" " source"
michael@0: Set the source directory to
michael@0: .IR source .
michael@0: The default source directory is the current directory.
michael@0: .TP
michael@0: .BI "\-d\fP, \fB\-\-destdir" " destination"
michael@0: Set the destination directory to
michael@0: .IR destination .
michael@0: The default destination directory is the current directory.
michael@0: .TP
michael@0: .BI "\-l\fP, \fB\-\-list"
michael@0: List the package items to stdout (after modifying the package).
michael@0: .SH LIST FILE SYNTAX
michael@0: Items are listed on one or more lines and separated by whitespace (space+tab).
michael@0: Comments begin with
michael@0: .B #
michael@0: and are ignored. Empty lines are ignored. Lines where the first non-whitespace
michael@0: character is one of "%&'()*+,-./:;<=>?_ are also ignored
michael@0: to reserve for future syntax.
michael@0: .PP
michael@0: Items for removal or extraction may contain a single 
michael@0: .B *
michael@0: wildcard character. The 
michael@0: .B *
michael@0: matches zero or more characters. If
michael@0: .BI "\-m\fP, \fB\-\-matchmode" " noslash"
michael@0: is set, then the
michael@0: .B *
michael@0: character does not match the
michael@0: .B /
michael@0: character.
michael@0: .PP
michael@0: Items must be listed relative to the package, and the
michael@0: .B "\fB\-\-sourcedir"
michael@0: or the
michael@0: .B "\fB\-\-destdir"
michael@0: path will be prepended. The paths are only prepended to item
michael@0: filenames while adding or extracting items, not to ICU .dat package or list
michael@0: filenames.
michael@0: .PP
michael@0: Paths may contain
michael@0: .B /
michael@0: instead of the platform's file separator character and are converted as
michael@0: appropriate.
michael@0: .SH AUTHORS
michael@0: Markus Scherer
michael@0: .br
michael@0: George Rhoten
michael@0: .SH VERSION
michael@0: 1.0
michael@0: .SH COPYRIGHT
michael@0: Copyright (C) 2006 IBM, Inc. and others.
michael@0: .SH SEE ALSO
michael@0: .BR pkgdata (1)
michael@0: .BR genrb (1)
michael@0: