[apple/icu.git] / icuSources / tools / genctd / genctd.1.in

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