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