ext/Unicode/Normalize/README

   1 Unicode/Normalize version 0.17
   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
  16   or
  17
  18
  19   use Unicode::Normalize 'normalize';
  20
  21   $NFD_string  = normalize('D',  $string);  # Normalization Form D
  22   $NFC_string  = normalize('C',  $string);  # Normalization Form C
  23   $NFKD_string = normalize('KD', $string);  # Normalization Form KD
  24   $NFKC_string = normalize('KC', $string);  # Normalization Form KC
  25
  26
  27 INSTALLATION
  28
  29 Perl 5.6 or later
  30
  31 To install this module type the following:
  32
  33    perl Makefile.PL
  34    make
  35    make test
  36    make install
  37
  38 If you have a C compiler and want to use the XS version,
  39 type the following:
  40
  41    perl Makefile.PL xs
  42    make
  43    make test
  44    make install
  45
  46 If you decide to install the NoXS version after trying to build the XS,
  47 type the following:
  48
  49    make clean
  50    perl Makefile.PL noxs
  51    make
  52    make test
  53    make install
  54
  55 DEPENDENCIES
  56
  57 This module requires these other modules and libraries:
  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) When these unicore/*.* files are updated;
  74
  75   in the case of an XS version:
  76     You must rebuild the module,
  77     as the data will be compiled on building.
  78
  79   in the case of a NoXS version:
  80     Rebuilding is not necessary,
  81     as the data will be read on requirement.
  82
  83 COPYRIGHT AND LICENCE
  84
  85   SADAHIRO Tomoyuki
  86
  87   SADAHIRO@cpan.org
  88
  89   http://homepage1.nifty.com/nomenclator/perl/
  90
  91   Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.
  92
  93   This program is free software; you can redistribute it and/or
  94   modify it under the same terms as Perl itself.