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