]> git.saurik.com Git - apple/icu.git/blob - icuSources/tools/gencfu/gencfu.1.in
ICU-57166.0.1.tar.gz
[apple/icu.git] / icuSources / tools / gencfu / gencfu.1.in
1 .\" Hey, Emacs! This is -*-nroff-*- you know...
2 .\"
3 .\" gencfu.1: manual page for the gencfu utility
4 .\"
5 .\" Copyright (C) 2012 International Business Machines Corporation and others
6 .\"
7 .TH GENCFU 1 "24 May 2009" "ICU MANPAGE" "ICU @VERSION@ Manual"
8 .SH NAME
9 .B gencfu
10 \- Generates Unicode Confusable data files
11 .SH SYNOPSIS
12 .B gencfu
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 "\-w\fP, \fB\-\-wsrules" " whole\-script\-rule\-file"
33 .BI "\-o\fP, \fB\-\-out" " output\-file"
34 .SH DESCRIPTION
35 .B gencfu
36 reads confusable character definitions in the input file, which are
37 plain text files containing confusable character
38 definitions in the input format defined by Unicode UAX39 for the files
39 .I confusables.txt
40 and
41 .I confusablesWholeScript.txt.
42 This source (.txt) format is also accepted by ICU spoof detectors.
43 The files must be encoded in utf-8 format, with or without a BOM.
44 Normally the output data file has the
45 .B .cfu
46 extension.
47 .SH OPTIONS
48 .TP
49 .BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
50 Print help about usage and exit.
51 .TP
52 .BR "\-V\fP, \fB\-\-version"
53 Print the version of
54 .B gencfu
55 and exit.
56 .TP
57 .BR "\-c\fP, \fB\-\-copyright"
58 Embeds the standard ICU copyright into the
59 .IR output-file .
60 .TP
61 .BR "\-v\fP, \fB\-\-verbose"
62 Display extra informative messages during execution.
63 .TP
64 .BI "\-d\fP, \fB\-\-destdir" " destination"
65 Set the destination directory of the
66 .IR output-file
67 to
68 .IR destination .
69 .TP
70 .BI "\-i\fP, \fB\-\-icudatadir" " directory"
71 Look for any necessary ICU data files in
72 .IR directory .
73 For example, the file
74 .B pnames.icu
75 must be located when ICU's data is not built as a shared library.
76 The default ICU data directory is specified by the environment variable
77 .BR ICU_DATA .
78 Most configurations of ICU do not require this argument.
79 .TP
80 .BI "\-r\fP, \fB\-\-rules" " rule\-file"
81 The source file to read.
82 .TP
83 .BI "\-w\fP, \fB\-\-wsrules" " whole\-script\-rule\-file"
84 The whole script source file to read.
85 .TP
86 .BI "\-o\fP, \fB\-\-out" " output\-file"
87 The output data file to write.
88 .SH VERSION
89 1.0
90 .SH COPYRIGHT
91 Copyright (C) 2009 International Business Machines Corporation and others