]> git.saurik.com Git - apple/icu.git/blame_incremental - icuSources/tools/genctd/genctd.1.in
ICU-8.11.1.tar.gz
[apple/icu.git] / icuSources / tools / genctd / genctd.1.in
... / ...
CommitLineData
1.\" Hey, Emacs! This is -*-nroff-*- you know...
2.\"
3.\" genctd.1: manual page for the genctd utility
4.\"
5.\" Copyright (C) 2006 IBM, Inc. and others.
6.\"
7.TH GENCTD 1 "8 March 2006" "ICU MANPAGE" "ICU @VERSION@ Manual"
8.SH NAME
9.B genctd
10\- Compiles word list into ICU compact trie dictionary
11.SH SYNOPSIS
12.B genctd
13[
14.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
15]
16[
17.BR "\-V\fP, \fB\-\-version"
18]
19[
20.BR "\-c\fP, \fB\-\-copyright"
21]
22[
23.BR "\-v\fP, \fB\-\-verbose"
24]
25[
26.BI "\-d\fP, \fB\-\-destdir" " destination"
27]
28[
29.BI "\-i\fP, \fB\-\-icudatadir" " directory"
30]
31.BI "\-o\fP, \fB\-\-out" " output\-file"
32.IR " dictionary\-file"
33.SH DESCRIPTION
34.B genctd
35reads the word list from
36.I dictionary-file
37and creates a compact trie dictionary file. Normally this data file has the
38.B .ctd
39extension.
40.PP
41Words begin at the beginning of a line and are terminated by the first whitespace.
42Lines that begin with whitespace are ignored.
43.SH OPTIONS
44.TP
45.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
46Print help about usage and exit.
47.TP
48.BR "\-V\fP, \fB\-\-version"
49Print the version of
50.B genctd
51and exit.
52.TP
53.BR "\-c\fP, \fB\-\-copyright"
54Embeds the standard ICU copyright into the
55.IR output-file .
56.TP
57.BR "\-v\fP, \fB\-\-verbose"
58Display extra informative messages during execution.
59.TP
60.BI "\-d\fP, \fB\-\-destdir" " destination"
61Set the destination directory of the
62.IR output-file
63to
64.IR destination .
65.TP
66.BI "\-i\fP, \fB\-\-icudatadir" " directory"
67Look for any necessary ICU data files in
68.IR directory .
69For example, the file
70.B pnames.icu
71must be located when ICU's data is not built as a shared library.
72The default ICU data directory is specified by the environment variable
73.BR ICU_DATA .
74Most configurations of ICU do not require this argument.
75.TP
76.BI " dictionary\-file"
77The source file to read.
78.TP
79.BI "\-o\fP, \fB\-\-out" " output\-file"
80The output data file to write.
81.SH CAVEATS
82When the
83.IR dictionary-file
84contains a byte order mark (BOM) at the beginning of the file, which is the Unicode character
85.B U+FEFF,
86then the
87.IR dictionary-file
88is interpreted as Unicode. Without the BOM,
89the file is interpreted in the current operating system default codepage.
90In order to eliminate any ambiguity of the encoding for how the
91.IR rule-file
92was written, it is recommended that you write this file in UTF-8
93with the BOM.
94.SH ENVIRONMENT
95.TP 10
96.B ICU_DATA
97Specifies the directory containing ICU data. Defaults to
98.BR @thepkgicudatadir@/@PACKAGE@/@VERSION@/ .
99Some tools in ICU depend on the presence of the trailing slash. It is thus
100important to make sure that it is present if
101.B ICU_DATA
102is set.
103.SH AUTHORS
104Deborah Goldsmith
105.SH VERSION
1061.0
107.SH COPYRIGHT
108Copyright (C) 2006 IBM, Inc. and others.
109.SH SEE ALSO
110.BR http://icu.sourceforge.net/userguide/boundaryAnalysis.html
111