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