Imported Upstream version 58.1
[platform/upstream/icu.git] / source / tools / gencnval / gencnval.1.in
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
2 .\"
3 .\" gencnval.1: manual page for the gencnval 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-2004 IBM, Inc. and others.
8 .\"
9 .\" Manual page by Yves Arrouye <yves@realnames.com>.
10 .\" Manual page by George Rhoten
11 .\"
12 .TH GENCNVAL 1 "11 March 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
13 .SH NAME
14 .B gencnval
15 \- compile the converters aliases file
16 .SH SYNOPSIS
17 .B gencnval
18 [
19 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
20 ]
21 [
22 .BR "\-v\fP, \fB\-\-verbose"
23 ]
24 [
25 .BR "\-c\fP, \fB\-\-copyright"
26 ]
27 [
28 .BI "\-s\fP, \fB\-\-sourcedir" " source"
29 ]
30 [
31 .BI "\-d\fP, \fB\-\-destdir" " destination"
32 ]
33 [
34 .I converterfile
35 ]
36 .SH DESCRIPTION
37 .B gencnval
38 converts the ICU aliases file
39 .I converterfile
40 into the binary file
41 .BR cnvalias.icu .
42 This binary file can then be read directly by ICU, or used by
43 .BR pkgdata (1)
44 for incorporation into a larger archive or library.
45 .PP
46 If
47 .I converterfile
48 is not provided, the default ICU
49 .B convrtrs.txt
50 file is used.
51 .SH OPTIONS
52 .TP
53 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
54 Print help about usage and exit.
55 .TP
56 .BR "\-v\fP, \fB\-\-verbose"
57 Display verbose output. This information can include information about
58 conflicting aliases and the converters the aliases resolve to.
59 .TP
60 .BR "\-c\fP, \fB\-\-copyright"
61 Include a copyright notice in the binary data.
62 .TP
63 .BI "\-s\fP, \fB\-\-sourcedir" " source"
64 Set the source directory to
65 .IR source .
66 The default source directory is specified by the environment variable
67 .BR ICU_DATA .
68 .TP
69 .BI "\-d\fP, \fB\-\-destdir" " destination"
70 Set the destination directory to
71 .IR destination .
72 The default destination directory is specified by the environment variable
73 .BR ICU_DATA .
74 .SH ENVIRONMENT
75 .TP 10
76 .B ICU_DATA
77 Specifies the directory containing ICU data. Defaults to
78 .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
79 Some tools in ICU depend on the presence of the trailing slash. It is thus
80 important to make sure that it is present if
81 .B ICU_DATA
82 is set.
83 .SH FILES
84 .TP \w'\fB@PACKAGE@/source/data/mappings/convrtrs.txt'u+3n
85 .B @PACKAGE@/source/data/mappings/convrtrs.txt
86 Description of ICU's converters and their aliases. This data file is not
87 normally installed, and it is available as a part of ICU source code.
88 .SH VERSION
89 @VERSION@
90 .SH COPYRIGHT
91 Copyright (C) 2000-2004 IBM, Inc. and others.
92 .SH SEE ALSO
93 .BR pkgdata (1)