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