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