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