scuffed-code/icu4c/source/tools/makeconv/makeconv.8.in
2000-10-12 21:12:58 +00:00

94 lines
2.1 KiB
Groff

.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" makeconv.8: manual page for the makeconv utility
.\"
.\" Copyright (C) 2000 IBM, Inc. and others.
.\"
.\" Manual page by Yves Arrouye <yves@realnames.com>.
.\"
.TH MAKECONV 8 "11 October 2000" "ICU @VERSION@"
.SH NAME
.B makeconv
\- compile a converter table
.SH SYNOPSIS
.B makeconv
[
.BR "\-V\fP, \fB\-\-version"
]
[
.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 (8)
for incorporation into a larger archive or library.
.PP
The
.I convertertable
must be in the IBM NLTC ucmap format in order to be understood by
.BR makeconv .
.PP
Note that converters will not be automatically found by ICU. They need to
be listed in the
.BR convrtrs.txt (5)
converters aliases file in order to be available to applications using ICU.
.SH OPTIONS
.BR \-V\fP, \fB\-\-version
Print the version of
.B makeconv
and exit.
.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 ENVIRONMENT
.TP 10
.B ICU_DATA
Specifies the directory containing ICU data. Defaults to
.BR @thedatadir@/icu/@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 (8)