jpayne@68: .\" Hey, Emacs! This is -*-nroff-*- you know...
jpayne@68: .\"
jpayne@68: .\" makeconv.1: manual page for the makeconv utility
jpayne@68: .\"
jpayne@68: .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
jpayne@68: .\" License & terms of use: http://www.unicode.org/copyright.html
jpayne@68: .\" Copyright (C) 2000-2002 IBM, Inc. and others.
jpayne@68: .\"
jpayne@68: .\" Manual page by Yves Arrouye <yves@realnames.com>.
jpayne@68: .\"
jpayne@68: .TH MAKECONV 1 "16 April 2002" "ICU MANPAGE" "ICU 67.1 Manual"
jpayne@68: .SH NAME
jpayne@68: .B makeconv
jpayne@68: \- compile a converter table
jpayne@68: .SH SYNOPSIS
jpayne@68: .B makeconv
jpayne@68: [
jpayne@68: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BR "\-c\fP, \fB\-\-copyright"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BR "\-v\fP, \fB\-\-verbose"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68: ]
jpayne@68: .IR convertertable " .\|.\|."
jpayne@68: .SH DESCRIPTION
jpayne@68: .B makeconv
jpayne@68: converts the ICU converter table
jpayne@68: .I convertertable
jpayne@68: into a binary file. The binary file has the same base name as
jpayne@68: .I convertertable
jpayne@68: but has a
jpayne@68: .B .cnv
jpayne@68: extension (instead of the typical
jpayne@68: .B .ucm
jpayne@68: extension of the
jpayne@68: .I convertertable
jpayne@68: file).
jpayne@68: This binary file can then be read directly by ICU, or used by
jpayne@68: .BR pkgdata (1)
jpayne@68: for incorporation into a larger archive or library.
jpayne@68: .PP
jpayne@68: The
jpayne@68: .I convertertable
jpayne@68: must be in the ICU ucm (Unicode Codepage Mapping) format in order to
jpayne@68: be understood by
jpayne@68: .BR makeconv .
jpayne@68: The ICU ucm format is similar to the IBM NLTC upmap/tpmap/rpmap files.
jpayne@68: Comments in the
jpayne@68: .I convertertable
jpayne@68: are handled as follows. If a comment (starting with a `#' sign) that
jpayne@68: is after some text does contain the fallback indicator `|' then only
jpayne@68: the text starting with the `#' sign, and ending before the `|' sign,
jpayne@68: is ignored.
jpayne@68: Otherwise, or if the comment is the first thing on the line,
jpayne@68: the comment runs up to the end of the line. This special
jpayne@68: handling of comments is to accommodate the practice of putting fallback
jpayne@68: information in comments in the strict IBM NLTC ucmap format.
jpayne@68: .PP
jpayne@68: Note that new converters will be automatically found by ICU after their
jpayne@68: installation in ICU's data directory. They do not need to
jpayne@68: be listed in the
jpayne@68: .BR convrtrs.txt (5)
jpayne@68: converters aliases file in order to be available to applications using ICU.
jpayne@68: They do need to be listed there if one wants to give them aliases, or
jpayne@68: tags, though.
jpayne@68: .SH OPTIONS
jpayne@68: .TP
jpayne@68: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
jpayne@68: Print help about usage and exit.
jpayne@68: .TP
jpayne@68: .BR "\-c\fP, \fB\-\-copyright"
jpayne@68: Include a copyright notice in the binary data.
jpayne@68: .TP
jpayne@68: .BR "\-v\fP, \fB\-\-verbose"
jpayne@68: Display extra informative messages during execution.
jpayne@68: .TP
jpayne@68: .BI "\-d\fP, \fB\-\-destdir" " destination"
jpayne@68: Set the destination directory to
jpayne@68: .IR destination .
jpayne@68: The default destination directory is specified by the environment variable
jpayne@68: .BR ICU_DATA .
jpayne@68: .SH CAVEATS
jpayne@68: If an existing converter table is changed and recompiled using
jpayne@68: .BR makeconv ,
jpayne@68: the resulting binary file must be packaged in the same way that it was
jpayne@68: packaged initially. For example, if converters were grouped together in
jpayne@68: an archive or a library with
jpayne@68: .BR pkgdata (1),
jpayne@68: then the archive or library must be rebuilt with the new binary file.
jpayne@68: A standalone binary converter file will not take precedence over a
jpayne@68: packaged one.
jpayne@68: .SH ENVIRONMENT
jpayne@68: .TP 10
jpayne@68: .B ICU_DATA
jpayne@68: Specifies the directory containing ICU data. Defaults to
jpayne@68: .BR ${prefix}/share/icu/67.1/ .
jpayne@68: Some tools in ICU depend on the presence of the trailing slash. It is thus
jpayne@68: important to make sure that it is present if
jpayne@68: .B ICU_DATA
jpayne@68: is set.
jpayne@68: .SH VERSION
jpayne@68: 67.1
jpayne@68: .SH COPYRIGHT
jpayne@68: Copyright (C) 2000 IBM, Inc. and others.
jpayne@68: .SH SEE ALSO
jpayne@68: .BR convrtrs.txt (5) 
jpayne@68: .br
jpayne@68: .BR pkgdata (1)
jpayne@68: