|
jpayne@68
|
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
|
|
jpayne@68
|
2 .\"
|
|
jpayne@68
|
3 .\" gencmn.8: manual page for the gencmn utility
|
|
jpayne@68
|
4 .\"
|
|
jpayne@68
|
5 .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
|
|
jpayne@68
|
6 .\" License & terms of use: http://www.unicode.org/copyright.html
|
|
jpayne@68
|
7 .\" Copyright (C) 2000-2001 IBM, Inc. and others.
|
|
jpayne@68
|
8 .\"
|
|
jpayne@68
|
9 .\" Manual page by Yves Arrouye <yves@realnames.com>.
|
|
jpayne@68
|
10 .\"
|
|
jpayne@68
|
11 .TH GENCMN 8 "5 November 2001" "ICU MANPAGE" "ICU 67.1 Manual"
|
|
jpayne@68
|
12 .SH NAME
|
|
jpayne@68
|
13 .B gencmn
|
|
jpayne@68
|
14 \- generate an ICU memory-mappable data file
|
|
jpayne@68
|
15 .SH SYNOPSIS
|
|
jpayne@68
|
16 .B gencmn
|
|
jpayne@68
|
17 [
|
|
jpayne@68
|
18 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
|
jpayne@68
|
19 ]
|
|
jpayne@68
|
20 [
|
|
jpayne@68
|
21 .BR "\-v\fP, \fB\-\-verbose"
|
|
jpayne@68
|
22 ]
|
|
jpayne@68
|
23 [
|
|
jpayne@68
|
24 .BR "\-c\fP, \fB\-\-copyright"
|
|
jpayne@68
|
25 |
|
|
jpayne@68
|
26 .BI "\-C\fP, \fB\-\-comment" " comment"
|
|
jpayne@68
|
27 ]
|
|
jpayne@68
|
28 [
|
|
jpayne@68
|
29 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
|
jpayne@68
|
30 ]
|
|
jpayne@68
|
31 [
|
|
jpayne@68
|
32 .BI "\-n\fP, \fB\-\-name" " name"
|
|
jpayne@68
|
33 ]
|
|
jpayne@68
|
34 [
|
|
jpayne@68
|
35 .BI "\-t\fP, \fB\-\-type" " fileext"
|
|
jpayne@68
|
36 ]
|
|
jpayne@68
|
37 [
|
|
jpayne@68
|
38 .BI "\-S\fP, \fB\-\-source"
|
|
jpayne@68
|
39 ]
|
|
jpayne@68
|
40 [
|
|
jpayne@68
|
41 .BI "\-e\fP, \fB\-\-entrypoint" " name"
|
|
jpayne@68
|
42 ]
|
|
jpayne@68
|
43 .I maxsize
|
|
jpayne@68
|
44 [
|
|
jpayne@68
|
45 .I listfilename
|
|
jpayne@68
|
46 ]
|
|
jpayne@68
|
47 .SH DESCRIPTION
|
|
jpayne@68
|
48 .B gencmn
|
|
jpayne@68
|
49 takes a set of files and packages them as an ICU memory-mappable data
|
|
jpayne@68
|
50 file. The resulting data file can then be used directly by ICU.
|
|
jpayne@68
|
51 .PP
|
|
jpayne@68
|
52 .B gencmn
|
|
jpayne@68
|
53 reads a list of files to be packaged from either the
|
|
jpayne@68
|
54 supplied
|
|
jpayne@68
|
55 .I listfilename
|
|
jpayne@68
|
56 file, or from its standard output. It packages all the files from
|
|
jpayne@68
|
57 the list that are not bigger than
|
|
jpayne@68
|
58 .I maxsize
|
|
jpayne@68
|
59 bytes, except if
|
|
jpayne@68
|
60 .I maxsize
|
|
jpayne@68
|
61 is 0, which indicates that there is no size limit on files.
|
|
jpayne@68
|
62 .SH OPTIONS
|
|
jpayne@68
|
63 .TP
|
|
jpayne@68
|
64 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
|
|
jpayne@68
|
65 Print help about usage and exit.
|
|
jpayne@68
|
66 .TP
|
|
jpayne@68
|
67 .BR "\-v\fP, \fB\-\-verbose"
|
|
jpayne@68
|
68 Display extra informative messages during execution.
|
|
jpayne@68
|
69 .TP
|
|
jpayne@68
|
70 .BR \-c\fP, \fB\-\-copyright
|
|
jpayne@68
|
71 Include the ICU copyright notice in the resulting data.
|
|
jpayne@68
|
72 .TP
|
|
jpayne@68
|
73 .BI "\-C\fP, \fB\-\-comment" " comment"
|
|
jpayne@68
|
74 Include the specified
|
|
jpayne@68
|
75 .I comment
|
|
jpayne@68
|
76 in the resulting data instead of the ICU copyright notice.
|
|
jpayne@68
|
77 .TP
|
|
jpayne@68
|
78 .BI "\-d\fP, \fB\-\-destdir" " destination"
|
|
jpayne@68
|
79 Set the destination directory to
|
|
jpayne@68
|
80 .IR destination .
|
|
jpayne@68
|
81 The default destination directory is specified by the environment variable
|
|
jpayne@68
|
82 .BR ICU_DATA .
|
|
jpayne@68
|
83 .TP
|
|
jpayne@68
|
84 .BI "\-n\fP, \fB\-\-name" " name"
|
|
jpayne@68
|
85 Set the data name to
|
|
jpayne@68
|
86 .I name
|
|
jpayne@68
|
87 instead of the default. This name is also used as the base name of the
|
|
jpayne@68
|
88 output. The default name is made of the
|
|
jpayne@68
|
89 .I icudt
|
|
jpayne@68
|
90 prefix, followed by a two-digit version number corresponding to
|
|
jpayne@68
|
91 the current version of the ICU release, and a single letter indicating
|
|
jpayne@68
|
92 the endianness of the data (the letter
|
|
jpayne@68
|
93 .I b
|
|
jpayne@68
|
94 indicated big endian data, and the letter
|
|
jpayne@68
|
95 .I l
|
|
jpayne@68
|
96 indicates little endian ones).
|
|
jpayne@68
|
97 .TP
|
|
jpayne@68
|
98 .BI "\-t\fP, \fB\-\-type" " type"
|
|
jpayne@68
|
99 Use
|
|
jpayne@68
|
100 .I type
|
|
jpayne@68
|
101 as the type of the data. This type is also used as the extension of
|
|
jpayne@68
|
102 the generated data file. The default type ie
|
|
jpayne@68
|
103 .IR dat .
|
|
jpayne@68
|
104 .TP
|
|
jpayne@68
|
105 .BI "\-S\fP, \fB\-\-source"
|
|
jpayne@68
|
106 Write a C source file with the table of contents of the data.
|
|
jpayne@68
|
107 .TP
|
|
jpayne@68
|
108 .BI "\-e\fP, \fB\-\-entrypoint" " name"
|
|
jpayne@68
|
109 Set the data entry point (used for linking against the data in a
|
|
jpayne@68
|
110 shared library form) to
|
|
jpayne@68
|
111 .IR name .
|
|
jpayne@68
|
112 The default entry point name is made of the data (set by the
|
|
jpayne@68
|
113 .BI "\-n\fP, \fB\-\-name"
|
|
jpayne@68
|
114 option) followed by an underscore and the type of the data (set by the
|
|
jpayne@68
|
115 .BI "\-t\fP, \fB\-\-type"
|
|
jpayne@68
|
116 option).
|
|
jpayne@68
|
117 .SH ENVIRONMENT
|
|
jpayne@68
|
118 .TP 10
|
|
jpayne@68
|
119 .B ICU_DATA
|
|
jpayne@68
|
120 Specifies the directory containing ICU data. Defaults to
|
|
jpayne@68
|
121 .BR ${prefix}/share/icu/67.1/ .
|
|
jpayne@68
|
122 Some tools in ICU depend on the presence of the trailing slash. It is thus
|
|
jpayne@68
|
123 important to make sure that it is present if
|
|
jpayne@68
|
124 .B ICU_DATA
|
|
jpayne@68
|
125 is set.
|
|
jpayne@68
|
126 .SH VERSION
|
|
jpayne@68
|
127 67.1
|
|
jpayne@68
|
128 .SH COPYRIGHT
|
|
jpayne@68
|
129 Copyright (C) 2000-2001 IBM, Inc. and others.
|
|
jpayne@68
|
130 .SH SEE ALSO
|
|
jpayne@68
|
131 .BR decmn (8)
|
