michael@0: .\" Hey, Emacs! This is -*-nroff-*- you know...
michael@0: .\"
michael@0: .\" gencmn.8: manual page for the gencmn utility
michael@0: .\"
michael@0: .\" Copyright (C) 2000-2001 IBM, Inc. and others.
michael@0: .\"
michael@0: .\" Manual page by Yves Arrouye <yves@realnames.com>.
michael@0: .\"
michael@0: .TH GENCMN 8 "5 November 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
michael@0: .SH NAME
michael@0: .B gencmn
michael@0: \- generate an ICU memory-mappable data file
michael@0: .SH SYNOPSIS
michael@0: .B gencmn
michael@0: [
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: ]
michael@0: [
michael@0: .BR "\-v\fP, \fB\-\-verbose"
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 "\-d\fP, \fB\-\-destdir" " destination"
michael@0: ]
michael@0: [
michael@0: .BI "\-n\fP, \fB\-\-name" " name"
michael@0: ]
michael@0: [
michael@0: .BI "\-t\fP, \fB\-\-type" " fileext"
michael@0: ]
michael@0: [
michael@0: .BI "\-S\fP, \fB\-\-source"
michael@0: ]
michael@0: [
michael@0: .BI "\-e\fP, \fB\-\-entrypoint" " name"
michael@0: ]
michael@0: .I maxsize
michael@0: [
michael@0: .I listfilename
michael@0: ]
michael@0: .SH DESCRIPTION
michael@0: .B gencmn
michael@0: takes a set of files and packages them as an ICU memory-mappable data
michael@0: file. The resulting data file can then be used directly by ICU.
michael@0: .PP
michael@0: .B gencmn
michael@0: reads a list of files to be packaged from either the
michael@0: supplied
michael@0: .I listfilename
michael@0: file, or from its standard output. It packages all the files from
michael@0: the list that are not bigger than
michael@0: .I maxsize
michael@0: bytes, except if
michael@0: .I maxsize
michael@0: is 0, which indicates that there is no size limit on files.
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: .BR "\-v\fP, \fB\-\-verbose"
michael@0: Display extra informative messages during execution.
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 "\-d\fP, \fB\-\-destdir" " destination"
michael@0: Set the destination directory to
michael@0: .IR destination .
michael@0: The default destination directory is specified by the environment variable
michael@0: .BR ICU_DATA .
michael@0: .TP
michael@0: .BI "\-n\fP, \fB\-\-name" " name"
michael@0: Set the data name to
michael@0: .I name
michael@0: instead of the default. This name is also used as the base name of the
michael@0: output. The default name is made of the
michael@0: .I icudt
michael@0: prefix, followed by a two-digit version number corresponding to
michael@0: the current version of the ICU release, and a single letter indicating
michael@0: the endianness of the data (the letter
michael@0: .I b
michael@0: indicated big endian data, and the letter
michael@0: .I l
michael@0: indicates little endian ones).
michael@0: .TP
michael@0: .BI "\-t\fP, \fB\-\-type" " type"
michael@0: Use
michael@0: .I type
michael@0: as the type of the data. This type is also used as the extension of
michael@0: the generated data file. The default type ie
michael@0: .IR dat .
michael@0: .TP
michael@0: .BI "\-S\fP, \fB\-\-source"
michael@0: Write a C source file with the table of contents of the data.
michael@0: .TP
michael@0: .BI "\-e\fP, \fB\-\-entrypoint" " name"
michael@0: Set the data entry point (used for linking against the data in a
michael@0: shared library form) to
michael@0: .IR name .
michael@0: The default entry point name is made of the data (set by the
michael@0: .BI "\-n\fP, \fB\-\-name"
michael@0: option) followed by an underscore and the type of the data (set by the
michael@0: .BI "\-t\fP, \fB\-\-type"
michael@0: option).
michael@0: .SH ENVIRONMENT
michael@0: .TP 10
michael@0: .B ICU_DATA
michael@0: Specifies the directory containing ICU data. Defaults to
michael@0: .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
michael@0: Some tools in ICU depend on the presence of the trailing slash. It is thus
michael@0: important to make sure that it is present if
michael@0: .B ICU_DATA
michael@0: is set.
michael@0: .SH VERSION
michael@0: @VERSION@
michael@0: .SH COPYRIGHT
michael@0: Copyright (C) 2000-2001 IBM, Inc. and others.
michael@0: .SH SEE ALSO
michael@0: .BR decmn (8)