[apple/icu.git] / icuSources / tools / makeconv / makeconv.1.in

.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" makeconv.1: manual page for the makeconv utility
.\"
.\" Copyright (C) 2016 and later: Unicode, Inc. and others.
.\" License & terms of use: http://www.unicode.org/copyright.html
.\" Copyright (C) 2000-2002 IBM, Inc. and others.
.\"
.\" Manual page by Yves Arrouye <yves@realnames.com>.
.\"
.TH MAKECONV 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
.SH NAME
.B makeconv
\- compile a converter table
.SH SYNOPSIS
.B makeconv
[
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
]
[
.BR "\-c\fP, \fB\-\-copyright"
]
[
.BR "\-v\fP, \fB\-\-verbose"
]
[
.BI "\-d\fP, \fB\-\-destdir" " destination"
]
.IR convertertable " .\|.\|."
.SH DESCRIPTION
.B makeconv
converts the ICU converter table
.I convertertable
into a binary file. The binary file has the same base name as
.I convertertable
but has a
.B .cnv
extension (instead of the typical
.B .ucm
extension of the
.I convertertable
file).
This binary file can then be read directly by ICU, or used by
.BR pkgdata (1)
for incorporation into a larger archive or library.
.PP
The
.I convertertable
must be in the ICU ucm (Unicode Codepage Mapping) format in order to
be understood by
.BR makeconv .
The ICU ucm format is similar to the IBM NLTC upmap/tpmap/rpmap files.
Comments in the
.I convertertable
are handled as follows. If a comment (starting with a `#' sign) that
is after some text does contain the fallback indicator `|' then only
the text starting with the `#' sign, and ending before the `|' sign,
is ignored.
Otherwise, or if the comment is the first thing on the line,
the comment runs up to the end of the line. This special
handling of comments is to accommodate the practice of putting fallback
information in comments in the strict IBM NLTC ucmap format.
.PP
Note that new converters will be automatically found by ICU after their
installation in ICU's data directory. They do not need to
be listed in the
.BR convrtrs.txt (5)
converters aliases file in order to be available to applications using ICU.
They do need to be listed there if one wants to give them aliases, or
tags, though.
.SH OPTIONS
.TP
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
Print help about usage and exit.
.TP
.BR "\-c\fP, \fB\-\-copyright"
Include a copyright notice in the binary data.
.TP
.BR "\-v\fP, \fB\-\-verbose"
Display extra informative messages during execution.
.TP
.BI "\-d\fP, \fB\-\-destdir" " destination"
Set the destination directory to
.IR destination .
The default destination directory is specified by the environment variable
.BR ICU_DATA .
.SH CAVEATS
If an existing converter table is changed and recompiled using
.BR makeconv ,
the resulting binary file must be packaged in the same way that it was
packaged initially. For example, if converters were grouped together in
an archive or a library with
.BR pkgdata (1),
then the archive or library must be rebuilt with the new binary file.
A standalone binary converter file will not take precedence over a
packaged one.
.SH ENVIRONMENT
.TP 10
.B ICU_DATA
Specifies the directory containing ICU data. Defaults to
.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
Some tools in ICU depend on the presence of the trailing slash. It is thus
important to make sure that it is present if
.B ICU_DATA
is set.
.SH VERSION
@VERSION@
.SH COPYRIGHT
Copyright (C) 2000 IBM, Inc. and others.
.SH SEE ALSO
.BR convrtrs.txt (5) 
.br
.BR pkgdata (1)
Commit	Line	Data
b75a7d8f A	1	.\" Hey, Emacs! This is --nroff-- you know...
	2	.\"
	3	.\" makeconv.1: manual page for the makeconv 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
b75a7d8f A	7	.\" Copyright (C) 2000-2002 IBM, Inc. and others.
	8	.\"
	9	.\" Manual page by Yves Arrouye <yves@realnames.com>.
	10	.\"
	11	.TH MAKECONV 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
	12	.SH NAME
	13	.B makeconv
	14	\- compile a converter table
	15	.SH SYNOPSIS
	16	.B makeconv
	17	[
	18	.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
	19	]
	20	[
	21	.BR "\-c\fP, \fB\-\-copyright"
	22	]
	23	[
	24	.BR "\-v\fP, \fB\-\-verbose"
	25	]
	26	[
	27	.BI "\-d\fP, \fB\-\-destdir" " destination"
	28	]
	29	.IR convertertable " .\\|.\\|."
	30	.SH DESCRIPTION
	31	.B makeconv
	32	converts the ICU converter table
	33	.I convertertable
	34	into a binary file. The binary file has the same base name as
	35	.I convertertable
	36	but has a
	37	.B .cnv
	38	extension (instead of the typical
	39	.B .ucm
	40	extension of the
	41	.I convertertable
	42	file).
	43	This binary file can then be read directly by ICU, or used by
	44	.BR pkgdata (1)
	45	for incorporation into a larger archive or library.
	46	.PP
	47	The
	48	.I convertertable
	49	must be in the ICU ucm (Unicode Codepage Mapping) format in order to
	50	be understood by
	51	.BR makeconv .
	52	The ICU ucm format is similar to the IBM NLTC upmap/tpmap/rpmap files.
	53	Comments in the
0f5d89e8	54	.I convertertable
b75a7d8f A	55	are handled as follows. If a comment (starting with a `#' sign) that
	56	is after some text does contain the fallback indicator `\|' then only
	57	the text starting with the `#' sign, and ending before the `\|' sign,
	58	is ignored.
	59	Otherwise, or if the comment is the first thing on the line,
	60	the comment runs up to the end of the line. This special
0f5d89e8	61	handling of comments is to accommodate the practice of putting fallback
b75a7d8f A	62	information in comments in the strict IBM NLTC ucmap format.
	63	.PP
	64	Note that new converters will be automatically found by ICU after their
	65	installation in ICU's data directory. They do not need to
	66	be listed in the
	67	.BR convrtrs.txt (5)
	68	converters aliases file in order to be available to applications using ICU.
	69	They do need to be listed there if one wants to give them aliases, or
	70	tags, though.
	71	.SH OPTIONS
	72	.TP
	73	.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
	74	Print help about usage and exit.
	75	.TP
	76	.BR "\-c\fP, \fB\-\-copyright"
	77	Include a copyright notice in the binary data.
	78	.TP
	79	.BR "\-v\fP, \fB\-\-verbose"
	80	Display extra informative messages during execution.
	81	.TP
	82	.BI "\-d\fP, \fB\-\-destdir" " destination"
	83	Set the destination directory to
	84	.IR destination .
	85	The default destination directory is specified by the environment variable
	86	.BR ICU_DATA .
	87	.SH CAVEATS
	88	If an existing converter table is changed and recompiled using
	89	.BR makeconv ,
	90	the resulting binary file must be packaged in the same way that it was
	91	packaged initially. For example, if converters were grouped together in
	92	an archive or a library with
	93	.BR pkgdata (1),
	94	then the archive or library must be rebuilt with the new binary file.
	95	A standalone binary converter file will not take precedence over a
	96	packaged one.
	97	.SH ENVIRONMENT
	98	.TP 10
	99	.B ICU_DATA
	100	Specifies the directory containing ICU data. Defaults to
	101	.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
	102	Some tools in ICU depend on the presence of the trailing slash. It is thus
	103	important to make sure that it is present if
	104	.B ICU_DATA
	105	is set.
	106	.SH VERSION
	107	@VERSION@
	108	.SH COPYRIGHT
	109	Copyright (C) 2000 IBM, Inc. and others.
	110	.SH SEE ALSO
	111	.BR convrtrs.txt (5)
	112	.br
	113	.BR pkgdata (1)
	114