]> granicus.if.org Git - icu/commitdiff
ICU-6966 add man page for gencfu. Changes from patch provided with ticket.
authorAndy Heninger <andy.heninger@gmail.com>
Tue, 24 Apr 2012 20:20:18 +0000 (20:20 +0000)
committerAndy Heninger <andy.heninger@gmail.com>
Tue, 24 Apr 2012 20:20:18 +0000 (20:20 +0000)
X-SVN-Rev: 31761

icu4c/source/tools/gencfu/Makefile.in
icu4c/source/tools/gencfu/gencfu.1.in [new file with mode: 0644]

index 0185606418490aac2024b640e44b2a5ec87aa54c..98ea0f0ab6819d0357097230ab9432b8fe8bfa19 100644 (file)
@@ -1,5 +1,5 @@
 ## Makefile.in for ICU - tools/gencfu
-## Copyright (c) 2009-2011 International Business Machines Corporation and
+## Copyright (c) 2009-2012 International Business Machines Corporation and
 ## others. All Rights Reserved.
 
 ## Source directory information
@@ -17,7 +17,7 @@ TARGET_STUB_NAME = gencfu
 
 SECTION = 1
 
-MAN_FILES = $(TARGET_STUB_NAME).$(SECTION)
+MAN_FILES = $(TARGET_STUB_NAME).$(SECTION)
 
 
 ## Extra files to remove for 'make clean'
@@ -55,8 +55,8 @@ install-local: all-local install-man
        $(INSTALL) $(TARGET) $(DESTDIR)$(bindir)
 
 install-man: $(MAN_FILES)
-#      $(MKINSTALLDIRS) $(DESTDIR)$(mandir)/man$(SECTION)
-#      $(INSTALL_DATA) $? $(DESTDIR)$(mandir)/man$(SECTION)
+       $(MKINSTALLDIRS) $(DESTDIR)$(mandir)/man$(SECTION)
+       $(INSTALL_DATA) $? $(DESTDIR)$(mandir)/man$(SECTION)
 
 dist-local:
 
diff --git a/icu4c/source/tools/gencfu/gencfu.1.in b/icu4c/source/tools/gencfu/gencfu.1.in
new file mode 100644 (file)
index 0000000..bbc9b75
--- /dev/null
@@ -0,0 +1,91 @@
+.\" Hey, Emacs! This is -*-nroff-*- you know...
+.\"
+.\" gencfu.1: manual page for the gencfu utility
+.\"
+.\" Copyright (C) 2012 International Business Machines Corporation and others
+.\"
+.TH GENCFU 1 "24 May 2009" "ICU MANPAGE" "ICU @VERSION@ Manual"
+.SH NAME
+.B gencfu
+\- Generates Unicode Confusable data files
+.SH SYNOPSIS
+.B gencfu
+[
+.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 "\-r\fP, \fB\-\-rules" " rule\-file"
+.BI "\-w\fP, \fB\-\-wsrules" " whole\-script\-rule\-file"
+.BI "\-o\fP, \fB\-\-out" " output\-file"
+.SH DESCRIPTION
+.B gencfu
+reads confusable character definitions in the input file, which are
+plain text files containing confusable character
+definitions in the input format defined by Unicode UAX39 for the files
+.I confusables.txt
+and
+.I confusablesWholeScript.txt.
+This source (.txt) format is also accepted by ICU spoof detectors.
+The files must be encoded in utf-8 format, with or without a BOM.
+Normally the output data file has the
+.B .cfu
+extension.
+.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 gencfu
+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 "\-r\fP, \fB\-\-rules" " rule\-file"
+The source file to read.
+.TP
+.BI "\-w\fP, \fB\-\-wsrules" " whole\-script\-rule\-file"
+The whole script source file to read.
+.TP
+.BI "\-o\fP, \fB\-\-out" " output\-file"
+The output data file to write.
+.SH VERSION
+1.0
+.SH COPYRIGHT
+Copyright (C) 2009 International Business Machines Corporation and others