ext/Unicode/Normalize/README

   1 Unicode/Normalize version 0.20
   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 or later
  28
  29 To install this module type the following:
  30
  31    perl Makefile.PL
  32    make
  33    make test
  34    make install
  35
  36 If you have a C compiler and want to use the XS version,
  37 type the following:
  38
  39    perl Makefile.PL xs
  40    make
  41    make test
  42    make install
  43
  44 If you decide to install the NoXS version after trying to build the XS,
  45 type the following:
  46
  47    make clean
  48    perl Makefile.PL noxs
  49    make
  50    make test
  51    make install
  52
  53 DEPENDENCIES
  54
  55 This module requires these other modules and libraries:
  56
  57 Carp
  58 Exporter
  59 File::Copy
  60 File::Spec
  61
  62 unicore/CombiningClass.pl         (or unicode/CombiningClass.pl)
  63 unicore/Decomposition.pl          (or unicode/Decomposition.pl)
  64 unicore/CompositionExclusions.txt (or unicode/CompExcl.txt)
  65
  66 CAVEAT
  67
  68 (1) In the perl-current, unicore/CompExcl.txt
  69   is renamed unicore/CompositionExclusions.txt.
  70
  71 (2) After these unicore/*.* files are updated.
  72
  73   In the case of an XS version:
  74     You must rebuild the module,
  75     as the data will be compiled on building.
  76
  77   In the case of a NoXS version:
  78     Rebuilding is not necessary,
  79     as the data will be read on requirement.
  80
  81 COPYRIGHT AND LICENCE
  82
  83   SADAHIRO Tomoyuki
  84
  85   SADAHIRO@cpan.org
  86
  87   http://homepage1.nifty.com/nomenclator/perl/
  88
  89   Copyright(C) 2001-2003, SADAHIRO Tomoyuki. Japan. All rights reserved.
  90
  91   This module is free software; you can redistribute it
  92   and/or modify it under the same terms as Perl itself.