← Back to branch summary

~ubuntu-branches/ubuntu/quantal/icu/quantal

« back to all changes in this revision

Viewing changes to source/tools/makeconv/makeconv.8.in

  • Committer: Package Import Robot
  • Author(s): Yves Arrouye
  • Date: 2002-03-03 15:31:13 UTC
  • Revision ID: package-import@ubuntu.com-20020303153113-3ssceqlq45xbmbnc
Tags: upstream-2.0-2.1pre20020303
Import upstream version 2.0-2.1pre20020303

Show diffs side-by-side

added added

removed removed

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