ext/Unicode/Normalize/README

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