1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/tools/genbrk/genbrk.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 +.\" genbrk.1: manual page for the genbrk utility
1.7 +.\"
1.8 +.\" Copyright (C) 2005-2006 International Business Machines Corporation and others
1.9 +.\"
1.10 +.TH GENBRK 1 "2 December 2005" "ICU MANPAGE" "ICU @VERSION@ Manual"
1.11 +.SH NAME
1.12 +.B genbrk
1.13 +\- Compiles ICU break iteration rules source files into binary data files
1.14 +.SH SYNOPSIS
1.15 +.B genbrk
1.16 +[
1.17 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.18 +]
1.19 +[
1.20 +.BR "\-V\fP, \fB\-\-version"
1.21 +]
1.22 +[
1.23 +.BR "\-c\fP, \fB\-\-copyright"
1.24 +]
1.25 +[
1.26 +.BR "\-v\fP, \fB\-\-verbose"
1.27 +]
1.28 +[
1.29 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.30 +]
1.31 +[
1.32 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.33 +]
1.34 +.BI "\-r\fP, \fB\-\-rules" " rule\-file"
1.35 +.BI "\-o\fP, \fB\-\-out" " output\-file"
1.36 +.SH DESCRIPTION
1.37 +.B genbrk
1.38 +reads the break (boundary) rule source code from
1.39 +.I rule-file
1.40 +and creates a break iteration data file. Normally this data file has the
1.41 +.B .brk
1.42 +extension.
1.43 +.PP
1.44 +The details of the rule syntax can be found in ICU's User Guide.
1.45 +.SH OPTIONS
1.46 +.TP
1.47 +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
1.48 +Print help about usage and exit.
1.49 +.TP
1.50 +.BR "\-V\fP, \fB\-\-version"
1.51 +Print the version of
1.52 +.B genbrk
1.53 +and exit.
1.54 +.TP
1.55 +.BR "\-c\fP, \fB\-\-copyright"
1.56 +Embeds the standard ICU copyright into the
1.57 +.IR output-file .
1.58 +.TP
1.59 +.BR "\-v\fP, \fB\-\-verbose"
1.60 +Display extra informative messages during execution.
1.61 +.TP
1.62 +.BI "\-d\fP, \fB\-\-destdir" " destination"
1.63 +Set the destination directory of the
1.64 +.IR output-file
1.65 +to
1.66 +.IR destination .
1.67 +.TP
1.68 +.BI "\-i\fP, \fB\-\-icudatadir" " directory"
1.69 +Look for any necessary ICU data files in
1.70 +.IR directory .
1.71 +For example, the file
1.72 +.B pnames.icu
1.73 +must be located when ICU's data is not built as a shared library.
1.74 +The default ICU data directory is specified by the environment variable
1.75 +.BR ICU_DATA .
1.76 +Most configurations of ICU do not require this argument.
1.77 +.TP
1.78 +.BI "\-r\fP, \fB\-\-rules" " rule\-file"
1.79 +The source file to read.
1.80 +.TP
1.81 +.BI "\-o\fP, \fB\-\-out" " output\-file"
1.82 +The output data file to write.
1.83 +.SH CAVEATS
1.84 +When the
1.85 +.IR rule-file
1.86 +contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character
1.87 +.B U+FEFF,
1.88 +then the
1.89 +.IR rule-file
1.90 +is interpreted as Unicode. Without the BOM,
1.91 +the file is interpreted in the current operating system default codepage.
1.92 +In order to eliminate any ambiguity of the encoding for how the
1.93 +.IR rule-file
1.94 +was written, it is recommended that you write this file in UTF-8
1.95 +with the BOM.
1.96 +.SH ENVIRONMENT
1.97 +.TP 10
1.98 +.B ICU_DATA
1.99 +Specifies the directory containing ICU data. Defaults to
1.100 +.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
1.101 +Some tools in ICU depend on the presence of the trailing slash. It is thus
1.102 +important to make sure that it is present if
1.103 +.B ICU_DATA
1.104 +is set.
1.105 +.SH AUTHORS
1.106 +George Rhoten
1.107 +.br
1.108 +Andy Heninger
1.109 +.SH VERSION
1.110 +1.0
1.111 +.SH COPYRIGHT
1.112 +Copyright (C) 2005 International Business Machines Corporation and others
1.113 +.SH SEE ALSO
1.114 +.BR http://www.icu-project.org/userguide/boundaryAnalysis.html
1.115 +
