1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/gencmn/gencmn.8.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,129 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" gencmn.8: manual page for the gencmn utility
1.7 +.\"
1.8 +.\" Copyright (C) 2000-2001 IBM, Inc. and others.
1.9 +.\"
1.10 +.\" Manual page by Yves Arrouye <yves@realnames.com>.
1.11 +.\"
1.12 +.TH GENCMN 8 "5 November 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.13 +.SH NAME
1.14 +.B gencmn
1.15 +\- generate an ICU memory-mappable data file
1.16 +.SH SYNOPSIS
1.17 +.B gencmn
1.18 +[
1.19 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.20 +]
1.21 +[
1.22 +.BR "\-v\fP, \fB\-\-verbose"
1.23 +]
1.24 +[
1.25 +.BR "\-c\fP, \fB\-\-copyright"
1.26 +|
1.27 +.BI "\-C\fP, \fB\-\-comment" " comment"
1.28 +]
1.29 +[
1.30 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.31 +]
1.32 +[
1.33 +.BI "\-n\fP, \fB\-\-name" " name"
1.34 +]
1.35 +[
1.36 +.BI "\-t\fP, \fB\-\-type" " fileext"
1.37 +]
1.38 +[
1.39 +.BI "\-S\fP, \fB\-\-source"
1.40 +]
1.41 +[
1.42 +.BI "\-e\fP, \fB\-\-entrypoint" " name"
1.43 +]
1.44 +.I maxsize
1.45 +[
1.46 +.I listfilename
1.47 +]
1.48 +.SH DESCRIPTION
1.49 +.B gencmn
1.50 +takes a set of files and packages them as an ICU memory-mappable data
1.51 +file. The resulting data file can then be used directly by ICU.
1.52 +.PP
1.53 +.B gencmn
1.54 +reads a list of files to be packaged from either the
1.55 +supplied
1.56 +.I listfilename
1.57 +file, or from its standard output. It packages all the files from
1.58 +the list that are not bigger than
1.59 +.I maxsize
1.60 +bytes, except if
1.61 +.I maxsize
1.62 +is 0, which indicates that there is no size limit on files.
1.63 +.SH OPTIONS
1.64 +.TP
1.65 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.66 +Print help about usage and exit.
1.67 +.TP
1.68 +.BR "\-v\fP, \fB\-\-verbose"
1.69 +Display extra informative messages during execution.
1.70 +.TP
1.71 +.BR \-c\fP, \fB\-\-copyright
1.72 +Include the ICU copyright notice in the resulting data.
1.73 +.TP
1.74 +.BI "\-C\fP, \fB\-\-comment" " comment"
1.75 +Include the specified
1.76 +.I comment
1.77 +in the resulting data instead of the ICU copyright notice.
1.78 +.TP
1.79 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.80 +Set the destination directory to
1.81 +.IR destination .
1.82 +The default destination directory is specified by the environment variable
1.83 +.BR ICU_DATA .
1.84 +.TP
1.85 +.BI "\-n\fP, \fB\-\-name" " name"
1.86 +Set the data name to
1.87 +.I name
1.88 +instead of the default. This name is also used as the base name of the
1.89 +output. The default name is made of the
1.90 +.I icudt
1.91 +prefix, followed by a two-digit version number corresponding to
1.92 +the current version of the ICU release, and a single letter indicating
1.93 +the endianness of the data (the letter
1.94 +.I b
1.95 +indicated big endian data, and the letter
1.96 +.I l
1.97 +indicates little endian ones).
1.98 +.TP
1.99 +.BI "\-t\fP, \fB\-\-type" " type"
1.100 +Use
1.101 +.I type
1.102 +as the type of the data. This type is also used as the extension of
1.103 +the generated data file. The default type ie
1.104 +.IR dat .
1.105 +.TP
1.106 +.BI "\-S\fP, \fB\-\-source"
1.107 +Write a C source file with the table of contents of the data.
1.108 +.TP
1.109 +.BI "\-e\fP, \fB\-\-entrypoint" " name"
1.110 +Set the data entry point (used for linking against the data in a
1.111 +shared library form) to
1.112 +.IR name .
1.113 +The default entry point name is made of the data (set by the
1.114 +.BI "\-n\fP, \fB\-\-name"
1.115 +option) followed by an underscore and the type of the data (set by the
1.116 +.BI "\-t\fP, \fB\-\-type"
1.117 +option).
1.118 +.SH ENVIRONMENT
1.119 +.TP 10
1.120 +.B ICU_DATA
1.121 +Specifies the directory containing ICU data. Defaults to
1.122 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.123 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.124 +important to make sure that it is present if
1.125 +.B ICU_DATA
1.126 +is set.
1.127 +.SH VERSION
1.128 +@VERSION@
1.129 +.SH COPYRIGHT
1.130 +Copyright (C) 2000-2001 IBM, Inc. and others.
1.131 +.SH SEE ALSO
1.132 +.BR decmn (8)
