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