intl/icu/source/tools/genbrk/genbrk.1.in@fc2d59ddac77 (annotated)
intl/icu/source/tools/genbrk/genbrk.1.in
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | .\" Hey, Emacs! This is -*-nroff-*- you know... |
| michael@0 | 2 | .\" |
| michael@0 | 3 | .\" genbrk.1: manual page for the genbrk utility |
| michael@0 | 4 | .\" |
| michael@0 | 5 | .\" Copyright (C) 2005-2006 International Business Machines Corporation and others |
| michael@0 | 6 | .\" |
| michael@0 | 7 | .TH GENBRK 1 "2 December 2005" "ICU MANPAGE" "ICU @VERSION@ Manual" |
| michael@0 | 8 | .SH NAME |
| michael@0 | 9 | .B genbrk |
| michael@0 | 10 | \- Compiles ICU break iteration rules source files into binary data files |
| michael@0 | 11 | .SH SYNOPSIS |
| michael@0 | 12 | .B genbrk |
| michael@0 | 13 | [ |
| michael@0 | 14 | .BR "\-h\fP, \fB\-?\fP, \fB\-\-help" |
| michael@0 | 15 | ] |
| michael@0 | 16 | [ |
| michael@0 | 17 | .BR "\-V\fP, \fB\-\-version" |
| michael@0 | 18 | ] |
| michael@0 | 19 | [ |
| michael@0 | 20 | .BR "\-c\fP, \fB\-\-copyright" |
| michael@0 | 21 | ] |
| michael@0 | 22 | [ |
| michael@0 | 23 | .BR "\-v\fP, \fB\-\-verbose" |
| michael@0 | 24 | ] |
| michael@0 | 25 | [ |
| michael@0 | 26 | .BI "\-d\fP, \fB\-\-destdir" " destination" |
| michael@0 | 27 | ] |
| michael@0 | 28 | [ |
| michael@0 | 29 | .BI "\-i\fP, \fB\-\-icudatadir" " directory" |
| michael@0 | 30 | ] |
| michael@0 | 31 | .BI "\-r\fP, \fB\-\-rules" " rule\-file" |
| michael@0 | 32 | .BI "\-o\fP, \fB\-\-out" " output\-file" |
| michael@0 | 33 | .SH DESCRIPTION |
| michael@0 | 34 | .B genbrk |
| michael@0 | 35 | reads the break (boundary) rule source code from |
| michael@0 | 36 | .I rule-file |
| michael@0 | 37 | and creates a break iteration data file. Normally this data file has the |
| michael@0 | 38 | .B .brk |
| michael@0 | 39 | extension. |
| michael@0 | 40 | .PP |
| michael@0 | 41 | The details of the rule syntax can be found in ICU's User Guide. |
| michael@0 | 42 | .SH OPTIONS |
| michael@0 | 43 | .TP |
| michael@0 | 44 | .BR "\-h\fP, \fB\-?\fP, \fB\-\-help" |
| michael@0 | 45 | Print help about usage and exit. |
| michael@0 | 46 | .TP |
| michael@0 | 47 | .BR "\-V\fP, \fB\-\-version" |
| michael@0 | 48 | Print the version of |
| michael@0 | 49 | .B genbrk |
| michael@0 | 50 | and exit. |
| michael@0 | 51 | .TP |
| michael@0 | 52 | .BR "\-c\fP, \fB\-\-copyright" |
| michael@0 | 53 | Embeds the standard ICU copyright into the |
| michael@0 | 54 | .IR output-file . |
| michael@0 | 55 | .TP |
| michael@0 | 56 | .BR "\-v\fP, \fB\-\-verbose" |
| michael@0 | 57 | Display extra informative messages during execution. |
| michael@0 | 58 | .TP |
| michael@0 | 59 | .BI "\-d\fP, \fB\-\-destdir" " destination" |
| michael@0 | 60 | Set the destination directory of the |
| michael@0 | 61 | .IR output-file |
| michael@0 | 62 | to |
| michael@0 | 63 | .IR destination . |
| michael@0 | 64 | .TP |
| michael@0 | 65 | .BI "\-i\fP, \fB\-\-icudatadir" " directory" |
| michael@0 | 66 | Look for any necessary ICU data files in |
| michael@0 | 67 | .IR directory . |
| michael@0 | 68 | For example, the file |
| michael@0 | 69 | .B pnames.icu |
| michael@0 | 70 | must be located when ICU's data is not built as a shared library. |
| michael@0 | 71 | The default ICU data directory is specified by the environment variable |
| michael@0 | 72 | .BR ICU_DATA . |
| michael@0 | 73 | Most configurations of ICU do not require this argument. |
| michael@0 | 74 | .TP |
| michael@0 | 75 | .BI "\-r\fP, \fB\-\-rules" " rule\-file" |
| michael@0 | 76 | The source file to read. |
| michael@0 | 77 | .TP |
| michael@0 | 78 | .BI "\-o\fP, \fB\-\-out" " output\-file" |
| michael@0 | 79 | The output data file to write. |
| michael@0 | 80 | .SH CAVEATS |
| michael@0 | 81 | When the |
| michael@0 | 82 | .IR rule-file |
| michael@0 | 83 | contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character |
| michael@0 | 84 | .B U+FEFF, |
| michael@0 | 85 | then the |
| michael@0 | 86 | .IR rule-file |
| michael@0 | 87 | is interpreted as Unicode. Without the BOM, |
| michael@0 | 88 | the file is interpreted in the current operating system default codepage. |
| michael@0 | 89 | In order to eliminate any ambiguity of the encoding for how the |
| michael@0 | 90 | .IR rule-file |
| michael@0 | 91 | was written, it is recommended that you write this file in UTF-8 |
| michael@0 | 92 | with the BOM. |
| michael@0 | 93 | .SH ENVIRONMENT |
| michael@0 | 94 | .TP 10 |
| michael@0 | 95 | .B ICU_DATA |
| michael@0 | 96 | Specifies the directory containing ICU data. Defaults to |
| michael@0 | 97 | .BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ . |
| michael@0 | 98 | Some tools in ICU depend on the presence of the trailing slash. It is thus |
| michael@0 | 99 | important to make sure that it is present if |
| michael@0 | 100 | .B ICU_DATA |
| michael@0 | 101 | is set. |
| michael@0 | 102 | .SH AUTHORS |
| michael@0 | 103 | George Rhoten |
| michael@0 | 104 | .br |
| michael@0 | 105 | Andy Heninger |
| michael@0 | 106 | .SH VERSION |
| michael@0 | 107 | 1.0 |
| michael@0 | 108 | .SH COPYRIGHT |
| michael@0 | 109 | Copyright (C) 2005 International Business Machines Corporation and others |
| michael@0 | 110 | .SH SEE ALSO |
| michael@0 | 111 | .BR http://www.icu-project.org/userguide/boundaryAnalysis.html |
| michael@0 | 112 |
