makeconv.1.in (3386B)
1 .\" Hey, Emacs! This is -*-nroff-*- you know... 2 .\" 3 .\" makeconv.1: manual page for the makeconv utility 4 .\" 5 .\" Copyright (C) 2016 and later: Unicode, Inc. and others. 6 .\" License & terms of use: http://www.unicode.org/copyright.html 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 54 .I convertertable 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 61 handling of comments is to accommodate the practice of putting fallback 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