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