icuSources/tools/genccode/genccode.8.in

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