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