ext/Unicode/Normalize/README

   1 Unicode/Normalize version 0.25
   2 ===================================
   3
   4 Unicode::Normalize - Unicode Normalization Forms
   5
   6 SYNOPSIS
   7
   8   use Unicode::Normalize;
   9
  10   $NFD_string  = NFD($string);  # Normalization Form D
  11   $NFC_string  = NFC($string);  # Normalization Form C
  12   $NFKD_string = NFKD($string); # Normalization Form KD
  13   $NFKC_string = NFKC($string); # Normalization Form KC
  14
  15   or
  16
  17   use Unicode::Normalize 'normalize';
  18
  19   $NFD_string  = normalize('D',  $string);  # Normalization Form D
  20   $NFC_string  = normalize('C',  $string);  # Normalization Form C
  21   $NFKD_string = normalize('KD', $string);  # Normalization Form KD
  22   $NFKC_string = normalize('KC', $string);  # Normalization Form KC
  23
  24
  25 INSTALLATION
  26
  27 Perl 5.6.1 or later (Caution: Perl 5.6.0 is not recommended.)
  28
  29 To install this module (XSUB: needs a C compiler), type the following:
  30
  31    perl Makefile.PL
  32    make
  33    make test
  34    make install
  35
  36 If you want to install pure Perl (i.e. no-XSUB),
  37 type the following (!! "disableXS" must run before "Makefile.PL" !!):
  38
  39    perl disableXS
  40    perl Makefile.PL
  41    make
  42    make test
  43    make install
  44
  45 After building no-XSUB, if you decide to install XSUB,
  46 type the following (!! "enableXS" must run before "Makefile.PL" !!):
  47
  48    make clean
  49    perl enableXS
  50    perl Makefile.PL
  51    make
  52    make test
  53    make install
  54
  55 DEPENDENCIES
  56
  57 This module requires other modules and libraries following:
  58
  59 Carp
  60 Exporter
  61 File::Copy
  62 File::Spec
  63
  64 unicore/CombiningClass.pl         (or unicode/CombiningClass.pl)
  65 unicore/Decomposition.pl          (or unicode/Decomposition.pl)
  66 unicore/CompositionExclusions.txt (or unicode/CompExcl.txt)
  67
  68 CAVEAT
  69
  70 (1) In the perl-current, unicore/CompExcl.txt
  71   is renamed unicore/CompositionExclusions.txt.
  72
  73 (2) After these unicore/*.* files are updated.
  74
  75   In the case of an XS edition:
  76     You must rebuild the module,
  77     as the data will be compiled on building.
  78
  79   In the case of a pure Perl edition:
  80     Rebuilding is not necessary,
  81     as the data will be read on requirement.
  82
  83 (3) Pure Perl edition, Normalize.pmN, may work without any other file
  84     in this distribution (it must be renamed Normalize.pm, though)
  85
  86 COPYRIGHT AND LICENCE
  87
  88   SADAHIRO Tomoyuki
  89
  90   SADAHIRO@cpan.org
  91
  92   http://homepage1.nifty.com/nomenclator/perl/
  93
  94   Copyright(C) 2001-2003, SADAHIRO Tomoyuki. Japan. All rights reserved.
  95
  96   This module is free software; you can redistribute it
  97   and/or modify it under the same terms as Perl itself.