1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/genccode/genccode.8.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,106 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" genccode.8: manual page for the gennames utility
1.7 +.\"
1.8 +.\" Copyright (C) 2003-2004 IBM, Inc. and others.
1.9 +.\"
1.10 +.TH GENCCODE 8 "11 March 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.11 +.SH NAME
1.12 +.B genccode
1.13 +\- generate C or platform specific assembly code from an ICU data file.
1.14 +.SH SYNOPSIS
1.15 +.B genccode
1.16 +[
1.17 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.18 +]
1.19 +[
1.20 +.BI "\-a\fP, \fB\-\-assembly" " name"
1.21 +]
1.22 +[
1.23 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.24 +]
1.25 +[
1.26 +.BI "\-n\fP, \fB\-\-name" " name"
1.27 +]
1.28 +[
1.29 +.BI "\-e\fP, \fB\-\-entrypoint" " name"
1.30 +]
1.31 +[
1.32 +.BI "\-f\fP, \fB\-\-filename" " name"
1.33 +]
1.34 +[
1.35 +.IR filename " .\|.\|."
1.36 +]
1.37 +.SH DESCRIPTION
1.38 +.B genccode
1.39 +reads each of the supplied
1.40 +.I filename
1.41 +and writes out a C file containing a compilable definition of the data in
1.42 +the data file.
1.43 +The C file name is made by taking the base name of the data
1.44 +.IR filename ,
1.45 +replacing dots by underscores, and adding a
1.46 +.I .c
1.47 +file extension.
1.48 +.PP
1.49 +If the \fB-a\fP option is used, platform specific assembly
1.50 +code is generated instead of C code.
1.51 +Most C compilers will accept both C and assembly files.
1.52 +Instead of writing a filename with a
1.53 +.I .c
1.54 +file extension, a filename with a
1.55 +.I .s
1.56 +will be written instead.
1.57 +.PP
1.58 +If
1.59 +.B genccode
1.60 +is called with no
1.61 +.I filename
1.62 +it terminates gracefully.
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 +.BI "\-a\fP, \fB\-\-assembly" " name"
1.69 +Output assembly code instead of C code.
1.70 +Use \fB-h\fP to see the list of available types of assembly to generate and
1.71 +to specify for this option.
1.72 +.TP
1.73 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.74 +Set the destination directory to
1.75 +.IR destination .
1.76 +The default destination directory is the current directory.
1.77 +.TP
1.78 +.BI "\-n\fP, \fB\-\-name" " name"
1.79 +Set the data name to
1.80 +.I name
1.81 +instead of the default. This name is also used as the base name of the
1.82 +output. The default name is made of the
1.83 +.I icudt
1.84 +prefix, followed by a two-digit version number corresponding to
1.85 +the current version of the ICU release, and a single letter indicating
1.86 +the endianness of the data (the letter
1.87 +.I b
1.88 +indicated big endian data, and the letter
1.89 +.I l
1.90 +indicates little endian ones).
1.91 +.TP
1.92 +.BI "\-f\fP, \fB\-\-filename" " name"
1.93 +Normally, an ICU data file such as mydata.icu will be turned into mydata_icu.c and mydata_icu.o.
1.94 +However, if this parameter was set to "somedata", the output files will be somedata.o and
1.95 +somedata.c, respectively.
1.96 +.TP
1.97 +.BI "\-e\fP, \fB\-\-entrypoint" " name"
1.98 +Set the data entry point (used for linking against the data in a
1.99 +shared library form) to
1.100 +.IR name .
1.101 +The default entry point name is made of the data (set by the
1.102 +.BI "\-n\fP, \fB\-\-name"
1.103 +option) followed by an underscore and the type of the data (set by the
1.104 +.BI "\-t\fP, \fB\-\-type"
1.105 +option).
1.106 +.SH VERSION
1.107 +@VERSION@
1.108 +.SH COPYRIGHT
1.109 +Copyright (C) 2000-2004 IBM, Inc. and others.
