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