[apple/icu.git] / icuSources / tools / genccode / genccode.8.in

.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" genccode.8: manual page for the gennames utility
.\"
.\" Copyright (C) 2016 and later: Unicode, Inc. and others.
.\" License & terms of use: http://www.unicode.org/copyright.html
.\" Copyright (C) 2003-2004 IBM, Inc. and others.
.\"
.TH GENCCODE 8 "11 March 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
.SH NAME
.B genccode
\- generate C or platform specific assembly code from an ICU data file.
.SH SYNOPSIS
.B genccode
[
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
]
[
.BI "\-a\fP, \fB\-\-assembly" " name"
]
[
.BI "\-d\fP, \fB\-\-destdir" " destination"
]
[
.BI "\-n\fP, \fB\-\-name" " name"
]
[
.BI "\-e\fP, \fB\-\-entrypoint" " name"
]
[
.BI "\-f\fP, \fB\-\-filename" " name"
]
[
.IR filename " .\|.\|."
]
.SH DESCRIPTION
.B genccode
reads each of the supplied
.I filename
and writes out a C file containing a compilable definition of the data in
the data file.
The C file name is made by taking the base name of the data
.IR filename ,
replacing dots by underscores, and adding a
.I .c
file extension.
.PP
If the \fB-a\fP option is used, platform specific assembly
code is generated instead of C code.
Most C compilers will accept both C and assembly files.
Instead of writing a filename with a
.I .c
file extension, a filename with a
.I .s
will be written instead.
.PP
If
.B genccode
is called with no
.I filename
it terminates gracefully.
.SH OPTIONS
.TP
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
Print help about usage and exit.
.TP
.BI "\-a\fP, \fB\-\-assembly" " name"
Output assembly code instead of C code.
Use \fB-h\fP to see the list of available types of assembly to generate and
to specify for this option.
.TP
.BI "\-d\fP, \fB\-\-destdir" " destination"
Set the destination directory to
.IR destination .
The default destination directory is the current directory.
.TP
.BI "\-n\fP, \fB\-\-name" " name"
Set the data name to
.I name
instead of the default. This name is also used as the base name of the
output. The default name is made of the
.I icudt
prefix, followed by a two-digit version number corresponding to
the current version of the ICU release, and a single letter indicating
the endianness of the data (the letter
.I b
indicated big endian data, and the letter
.I l
indicates little endian ones).
.TP
.BI "\-f\fP, \fB\-\-filename" " name"
Normally, an ICU data file such as mydata.icu will be turned into mydata_icu.c and mydata_icu.o.
However, if this parameter was set to "somedata", the output files will be somedata.o and 
somedata.c, respectively.
.TP
.BI "\-e\fP, \fB\-\-entrypoint" " name"
Set the data entry point (used for linking against the data in a
shared library form) to
.IR name .
The default entry point name is made of the data (set by the
.BI "\-n\fP, \fB\-\-name"
option) followed by an underscore and the type of the data (set by the
.BI "\-t\fP, \fB\-\-type"
option).
.SH VERSION
@VERSION@
.SH COPYRIGHT
Copyright (C) 2000-2004 IBM, Inc. and others.
Commit	Line	Data
b75a7d8f A	1	.\" Hey, Emacs! This is --nroff-- you know...
	2	.\"
	3	.\" genccode.8: manual page for the gennames utility
	4	.\"
f3c0d7a5 A	5	.\" Copyright (C) 2016 and later: Unicode, Inc. and others.
f3c0d7a5 A	6	.\" License & terms of use: http://www.unicode.org/copyright.html
374ca955	7	.\" Copyright (C) 2003-2004 IBM, Inc. and others.
b75a7d8f	8	.\"
374ca955	9	.TH GENCCODE 8 "11 March 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
b75a7d8f A	10	.SH NAME
b75a7d8f A	11	.B genccode
374ca955	12	\- generate C or platform specific assembly code from an ICU data file.
b75a7d8f A	13	.SH SYNOPSIS
	14	.B genccode
	15	[
	16	.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
	17	]
	18	[
374ca955 A	19	.BI "\-a\fP, \fB\-\-assembly" " name"
	20	]
	21	[
b75a7d8f A	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	[
374ca955 A	31	.BI "\-f\fP, \fB\-\-filename" " name"
	32	]
	33	[
b75a7d8f A	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
374ca955 A	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
b75a7d8f A	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
374ca955 A	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
b75a7d8f A	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
374ca955 A	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
b75a7d8f A	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
374ca955	108	Copyright (C) 2000-2004 IBM, Inc. and others.