git.saurik.com Git - apple/icu.git/blame_incremental - icuSources/tools/genbrk/genbrk.1.in

... / ...

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