michael@0: .\" Hey, Emacs! This is -*-nroff-*- you know...
michael@0: .\"
michael@0: .\" genbrk.1: manual page for the genbrk utility
michael@0: .\"
michael@0: .\" Copyright (C) 2005-2006 International Business Machines Corporation and others
michael@0: .\"
michael@0: .TH GENBRK 1 "2 December 2005" "ICU MANPAGE" "ICU @VERSION@ Manual"
michael@0: .SH NAME
michael@0: .B genbrk
michael@0: \- Compiles ICU break iteration rules source files into binary data files
michael@0: .SH SYNOPSIS
michael@0: .B genbrk
michael@0: [
michael@0: .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
michael@0: ]
michael@0: [
michael@0: .BR "\-V\fP, \fB\-\-version"
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: [
michael@0: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
michael@0: ]
michael@0: .BI "\-r\fP, \fB\-\-rules" " rule\-file"
michael@0: .BI "\-o\fP, \fB\-\-out" " output\-file"
michael@0: .SH DESCRIPTION
michael@0: .B genbrk
michael@0: reads the break (boundary) rule source code from
michael@0: .I rule-file
michael@0: and creates a break iteration data file. Normally this data file has the 
michael@0: .B .brk
michael@0: extension.
michael@0: .PP
michael@0: The details of the rule syntax can be found in ICU's User Guide.
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 "\-V\fP, \fB\-\-version"
michael@0: Print the version of
michael@0: .B genbrk
michael@0: and exit.
michael@0: .TP
michael@0: .BR "\-c\fP, \fB\-\-copyright"
michael@0: Embeds the standard ICU copyright into the
michael@0: .IR output-file .
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 of the
michael@0: .IR output-file
michael@0: to
michael@0: .IR destination .
michael@0: .TP
michael@0: .BI "\-i\fP, \fB\-\-icudatadir" " directory"
michael@0: Look for any necessary ICU data files in
michael@0: .IR directory .
michael@0: For example, the file
michael@0: .B pnames.icu
michael@0: must be located when ICU's data is not built as a shared library.
michael@0: The default ICU data directory is specified by the environment variable
michael@0: .BR ICU_DATA .
michael@0: Most configurations of ICU do not require this argument.
michael@0: .TP
michael@0: .BI "\-r\fP, \fB\-\-rules" " rule\-file"
michael@0: The source file to read.
michael@0: .TP
michael@0: .BI "\-o\fP, \fB\-\-out" " output\-file"
michael@0: The output data file to write.
michael@0: .SH CAVEATS
michael@0: When the
michael@0: .IR rule-file
michael@0: contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character
michael@0: .B U+FEFF,
michael@0: then the
michael@0: .IR rule-file
michael@0: is interpreted as Unicode. Without the BOM,
michael@0: the file is interpreted in the current operating system default codepage.
michael@0: In order to eliminate any ambiguity of the encoding for how the
michael@0: .IR rule-file
michael@0: was written, it is recommended that you write this file in UTF-8
michael@0: with the BOM.
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 AUTHORS
michael@0: George Rhoten
michael@0: .br
michael@0: Andy Heninger
michael@0: .SH VERSION
michael@0: 1.0
michael@0: .SH COPYRIGHT
michael@0: Copyright (C) 2005 International Business Machines Corporation and others
michael@0: .SH SEE ALSO
michael@0: .BR http://www.icu-project.org/userguide/boundaryAnalysis.html
michael@0: