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