1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/makeconv/makeconv.1.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,112 @@
1.4 +.\" Hey, Emacs! This is -*-nroff-*- you know...
1.5 +.\"
1.6 +.\" makeconv.1: manual page for the makeconv utility
1.7 +.\"
1.8 +.\" Copyright (C) 2000-2002 IBM, Inc. and others.
1.9 +.\"
1.10 +.\" Manual page by Yves Arrouye <yves@realnames.com>.
1.11 +.\"
1.12 +.TH MAKECONV 1 "16 April 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.13 +.SH NAME
1.14 +.B makeconv
1.15 +\- compile a converter table
1.16 +.SH SYNOPSIS
1.17 +.B makeconv
1.18 +[
1.19 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.20 +]
1.21 +[
1.22 +.BR "\-c\fP, \fB\-\-copyright"
1.23 +]
1.24 +[
1.25 +.BR "\-v\fP, \fB\-\-verbose"
1.26 +]
1.27 +[
1.28 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.29 +]
1.30 +.IR convertertable " .\|.\|."
1.31 +.SH DESCRIPTION
1.32 +.B makeconv
1.33 +converts the ICU converter table
1.34 +.I convertertable
1.35 +into a binary file. The binary file has the same base name as
1.36 +.I convertertable
1.37 +but has a
1.38 +.B .cnv
1.39 +extension (instead of the typical
1.40 +.B .ucm
1.41 +extension of the
1.42 +.I convertertable
1.43 +file).
1.44 +This binary file can then be read directly by ICU, or used by
1.45 +.BR pkgdata (1)
1.46 +for incorporation into a larger archive or library.
1.47 +.PP
1.48 +The
1.49 +.I convertertable
1.50 +must be in the ICU ucm (Unicode Codepage Mapping) format in order to
1.51 +be understood by
1.52 +.BR makeconv .
1.53 +The ICU ucm format is similar to the IBM NLTC upmap/tpmap/rpmap files.
1.54 +Comments in the
1.55 +.I convertable
1.56 +are handled as follows. If a comment (starting with a `#' sign) that
1.57 +is after some text does contain the fallback indicator `|' then only
1.58 +the text starting with the `#' sign, and ending before the `|' sign,
1.59 +is ignored.
1.60 +Otherwise, or if the comment is the first thing on the line,
1.61 +the comment runs up to the end of the line. This special
1.62 +handling of comments is to accomodate the practice of putting fallback
1.63 +information in comments in the strict IBM NLTC ucmap format.
1.64 +.PP
1.65 +Note that new converters will be automatically found by ICU after their
1.66 +installation in ICU's data directory. They do not need to
1.67 +be listed in the
1.68 +.BR convrtrs.txt (5)
1.69 +converters aliases file in order to be available to applications using ICU.
1.70 +They do need to be listed there if one wants to give them aliases, or
1.71 +tags, though.
1.72 +.SH OPTIONS
1.73 +.TP
1.74 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.75 +Print help about usage and exit.
1.76 +.TP
1.77 +.BR "\-c\fP, \fB\-\-copyright"
1.78 +Include a copyright notice in the binary data.
1.79 +.TP
1.80 +.BR "\-v\fP, \fB\-\-verbose"
1.81 +Display extra informative messages during execution.
1.82 +.TP
1.83 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.84 +Set the destination directory to
1.85 +.IR destination .
1.86 +The default destination directory is specified by the environment variable
1.87 +.BR ICU_DATA .
1.88 +.SH CAVEATS
1.89 +If an existing converter table is changed and recompiled using
1.90 +.BR makeconv ,
1.91 +the resulting binary file must be packaged in the same way that it was
1.92 +packaged initially. For example, if converters were grouped together in
1.93 +an archive or a library with
1.94 +.BR pkgdata (1),
1.95 +then the archive or library must be rebuilt with the new binary file.
1.96 +A standalone binary converter file will not take precedence over a
1.97 +packaged one.
1.98 +.SH ENVIRONMENT
1.99 +.TP 10
1.100 +.B ICU_DATA
1.101 +Specifies the directory containing ICU data. Defaults to
1.102 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.103 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.104 +important to make sure that it is present if
1.105 +.B ICU_DATA
1.106 +is set.
1.107 +.SH VERSION
1.108 +@VERSION@
1.109 +.SH COPYRIGHT
1.110 +Copyright (C) 2000 IBM, Inc. and others.
1.111 +.SH SEE ALSO
1.112 +.BR convrtrs.txt (5)
1.113 +.br
1.114 +.BR pkgdata (1)
1.115 +
