intl/icu/source/tools/genccode/genccode.8.in@fc2d59ddac77 (annotated)
intl/icu/source/tools/genccode/genccode.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 | .\" genccode.8: manual page for the gennames utility |
| michael@0 | 4 | .\" |
| michael@0 | 5 | .\" Copyright (C) 2003-2004 IBM, Inc. and others. |
| michael@0 | 6 | .\" |
| michael@0 | 7 | .TH GENCCODE 8 "11 March 2004" "ICU MANPAGE" "ICU @VERSION@ Manual" |
| michael@0 | 8 | .SH NAME |
| michael@0 | 9 | .B genccode |
| michael@0 | 10 | \- generate C or platform specific assembly code from an ICU data file. |
| michael@0 | 11 | .SH SYNOPSIS |
| michael@0 | 12 | .B genccode |
| michael@0 | 13 | [ |
| michael@0 | 14 | .BR "\-h\fP, \fB\-?\fP, \fB\-\-help" |
| michael@0 | 15 | ] |
| michael@0 | 16 | [ |
| michael@0 | 17 | .BI "\-a\fP, \fB\-\-assembly" " name" |
| michael@0 | 18 | ] |
| michael@0 | 19 | [ |
| michael@0 | 20 | .BI "\-d\fP, \fB\-\-destdir" " destination" |
| michael@0 | 21 | ] |
| michael@0 | 22 | [ |
| michael@0 | 23 | .BI "\-n\fP, \fB\-\-name" " name" |
| michael@0 | 24 | ] |
| michael@0 | 25 | [ |
| michael@0 | 26 | .BI "\-e\fP, \fB\-\-entrypoint" " name" |
| michael@0 | 27 | ] |
| michael@0 | 28 | [ |
| michael@0 | 29 | .BI "\-f\fP, \fB\-\-filename" " name" |
| michael@0 | 30 | ] |
| michael@0 | 31 | [ |
| michael@0 | 32 | .IR filename " .\|.\|." |
| michael@0 | 33 | ] |
| michael@0 | 34 | .SH DESCRIPTION |
| michael@0 | 35 | .B genccode |
| michael@0 | 36 | reads each of the supplied |
| michael@0 | 37 | .I filename |
| michael@0 | 38 | and writes out a C file containing a compilable definition of the data in |
| michael@0 | 39 | the data file. |
| michael@0 | 40 | The C file name is made by taking the base name of the data |
| michael@0 | 41 | .IR filename , |
| michael@0 | 42 | replacing dots by underscores, and adding a |
| michael@0 | 43 | .I .c |
| michael@0 | 44 | file extension. |
| michael@0 | 45 | .PP |
| michael@0 | 46 | If the \fB-a\fP option is used, platform specific assembly |
| michael@0 | 47 | code is generated instead of C code. |
| michael@0 | 48 | Most C compilers will accept both C and assembly files. |
| michael@0 | 49 | Instead of writing a filename with a |
| michael@0 | 50 | .I .c |
| michael@0 | 51 | file extension, a filename with a |
| michael@0 | 52 | .I .s |
| michael@0 | 53 | will be written instead. |
| michael@0 | 54 | .PP |
| michael@0 | 55 | If |
| michael@0 | 56 | .B genccode |
| michael@0 | 57 | is called with no |
| michael@0 | 58 | .I filename |
| michael@0 | 59 | it terminates gracefully. |
| 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 | .BI "\-a\fP, \fB\-\-assembly" " name" |
| michael@0 | 66 | Output assembly code instead of C code. |
| michael@0 | 67 | Use \fB-h\fP to see the list of available types of assembly to generate and |
| michael@0 | 68 | to specify for this option. |
| michael@0 | 69 | .TP |
| michael@0 | 70 | .BI "\-d\fP, \fB\-\-destdir" " destination" |
| michael@0 | 71 | Set the destination directory to |
| michael@0 | 72 | .IR destination . |
| michael@0 | 73 | The default destination directory is the current directory. |
| michael@0 | 74 | .TP |
| michael@0 | 75 | .BI "\-n\fP, \fB\-\-name" " name" |
| michael@0 | 76 | Set the data name to |
| michael@0 | 77 | .I name |
| michael@0 | 78 | instead of the default. This name is also used as the base name of the |
| michael@0 | 79 | output. The default name is made of the |
| michael@0 | 80 | .I icudt |
| michael@0 | 81 | prefix, followed by a two-digit version number corresponding to |
| michael@0 | 82 | the current version of the ICU release, and a single letter indicating |
| michael@0 | 83 | the endianness of the data (the letter |
| michael@0 | 84 | .I b |
| michael@0 | 85 | indicated big endian data, and the letter |
| michael@0 | 86 | .I l |
| michael@0 | 87 | indicates little endian ones). |
| michael@0 | 88 | .TP |
| michael@0 | 89 | .BI "\-f\fP, \fB\-\-filename" " name" |
| michael@0 | 90 | Normally, an ICU data file such as mydata.icu will be turned into mydata_icu.c and mydata_icu.o. |
| michael@0 | 91 | However, if this parameter was set to "somedata", the output files will be somedata.o and |
| michael@0 | 92 | somedata.c, respectively. |
| michael@0 | 93 | .TP |
| michael@0 | 94 | .BI "\-e\fP, \fB\-\-entrypoint" " name" |
| michael@0 | 95 | Set the data entry point (used for linking against the data in a |
| michael@0 | 96 | shared library form) to |
| michael@0 | 97 | .IR name . |
| michael@0 | 98 | The default entry point name is made of the data (set by the |
| michael@0 | 99 | .BI "\-n\fP, \fB\-\-name" |
| michael@0 | 100 | option) followed by an underscore and the type of the data (set by the |
| michael@0 | 101 | .BI "\-t\fP, \fB\-\-type" |
| michael@0 | 102 | option). |
| michael@0 | 103 | .SH VERSION |
| michael@0 | 104 | @VERSION@ |
| michael@0 | 105 | .SH COPYRIGHT |
| michael@0 | 106 | Copyright (C) 2000-2004 IBM, Inc. and others. |
