1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
.\" Generated by manscript from ucm2ltc.1.txt
.TH "UCM2LTC" "1" "2013/03/24" "Version 0.3.4" "Convert a UCM file to an LTC source"
.hw /usr/share/doc/libtranscript-0.3.4 http://os.ghalkes.nl/libtranscript.html
.SH NAME
ucm2ltc \- convert a UCM file to an LTC source
.SH SYNOPSIS
\fBucm2ltc\fR [\fIOPTIONS\fR...] ([\-c] [\-i] [\-n\fINAME\fR] \fIFILE\fR...)
.SH DESCRIPTION
\fBucm2ltc\fR converts a UCM description of a character set to the C source for
an LTC (LibTranscript Converter). The UCM description may contain several
extra constructs specific to \fBucm2ltc\fR, described below.
.SH OPTIONS
\fBucm2ltc\fR accepts the following options:
.PP
.TP
\fB\-D\fR, \fB\-\-dump\fR
Dump the input as a UCM description of the converter. Only the input files up
to the first \-c option are considered.
.TP
\fB\-c\fR, \fB\-\-concatenate\fR
When multiple input files are specified, \fBucm2ltc\fR normally creates a
single main converter, with several delta converters. This mode of operation is
desirable when the specified input files are small variations, because it can
save space. However, sometimes it is desirable to bunch a set of converters in
a single LTC because the converters may be related, but not variations of a
single converter. By specifying the \-c option before an input file that
is not a variation of the previous input file, \fBucm2ltc\fR will treat the
following input files as the specification of a separate converter, but will
output a single LTC source file.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a short help message.
.TP
\fB\-i\fR, \fB\-\-internal\fR
Specify that the following input file is to be considered an internal
converter, only to be used by another LTC module. A converter built with the
\-i flag can not be opened by clients of the \fBlibtranscript\fR library, only by
other LTC modules.
.TP
\fB\-I\fR, \fB\-\-allow\-ibm\-rotate\fR
Some UCM files provided by IBM map the Unicode characters U+001A, U+001C and
U+007F to the output bytes 7F 1A and 1C respectively. This rotated mapping is
IBM specific, and therefore \fBucm2ltc\fR normally undoes this. However, in some
instances it is desirable to keep this rotated mapping. This option instructs
\fBucm2ltc\fR to keep the rotated mapping intact.
.TP
\fB\-n\fR \fIname\fR, \fB\-\-name\fR=\fIname\fR
Set the name of the converter to \fIname\fR. Normally the name of the input
file is taken as the name of the converter (without the .ucm extension).
.TP
\fB\-o\fR \fIoutput\fR, \fB\-\-output\fR=\fIoutput\fR
Write the output to \fIoutput\fR. If not specified, the input file name is
used, with the .ucm extension replaced with .c. This option is required if more
than one input file is provided.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Produce verbose output to standard error. Specifiy this option multiple times
to increase verbosity.
.PP
To stop \fBucm2ltc\fR from interpreting file names that start with a dash as
options, one can specify a double dash (\-\-) after which \fBucm2ltc\fR will
interpret any following arguments as files to read.
.SH UCM\ EXTENSIONS
\fBucm2ltc\fR accepts several extensions to the basic UCM file format:
.PP
.IP \(bu
In the UCM header, the <transcript:internal> tag is accepted to indicate that
this converter is only to be used as an internal converter. This has the same
effect as the \-i option.
.IP \(bu
M:N mappings can be included in the main CHARMAP, and do not have to be
separated into the second CHARMAP entry.
.IP \(bu
After the main CHARMAP, delta maps can be included by using
VARIANT [INTERNAL] <name> ... END VARIANT. If delta maps are included, the main
CHARMAP is not included as a converter. Only the delta converters are available
in the LTC. To include the CHARMAP as a separate entry, include an empty delta
map.
.SH BUGS
If you think you have found a bug, please check that you are using the latest
version of \fBlibtranscript\fR <http://os.ghalkes.nl/libtranscript.html>. When
reporting bugs, please include a minimal example that demonstrates the problem.
.SH AUTHOR
G.P. Halkes <libtranscript@ghalkes.nl>
.SH COPYRIGHT
Copyright \(co 2011\-2013 G.P. Halkes
.br
\fBlibtranscript\fR is licensed under the GNU General Public License version\ 3.
.br
For more details on the license, see the file COPYING in the documentation
directory. On Un*x systems this is usually /usr/share/doc/libtranscript.
|
