cpan/Unicode-Normalize/README

   1 Unicode/Normalize version 1.13
   2 ===================================
   3
   4 Unicode::Normalize - Unicode Normalization Forms
   5
   6 SYNOPSIS
   7
   8 (1) using function names exported by default:
   9
  10   use Unicode::Normalize;
  11
  12   $NFD_string  = NFD($string);  # Normalization Form D
  13   $NFC_string  = NFC($string);  # Normalization Form C
  14   $NFKD_string = NFKD($string); # Normalization Form KD
  15   $NFKC_string = NFKC($string); # Normalization Form KC
  16
  17 (2) using function names exported on request:
  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 INSTALLATION
  27
  28 Perl 5.6.1 or later is required.
  29 Perl 5.8.1 or later is recommended.
  30
  31 To install this module (XSUB: needs a C compiler), type the following:
  32
  33    perl Makefile.PL
  34    make
  35    make test
  36    make install
  37
  38 If you want to install pure Perl (i.e. no-XSUB),
  39 type the following (!! "disableXS" must run before "Makefile.PL" !!):
  40
  41    perl disableXS
  42    perl Makefile.PL
  43    make
  44    make test
  45    make install
  46
  47 After building no-XSUB, if you decide to install XSUB,
  48 type the following (!! "enableXS" must run before "Makefile.PL" !!):
  49
  50    make clean
  51    perl enableXS
  52    perl Makefile.PL
  53    make
  54    make test
  55    make install
  56
  57 DEPENDENCIES
  58
  59 This module requires some core modules and pragmas,
  60 and the following files from Unicode Character Database,
  61 which are included in recent perl core distributions.
  62
  63 - unicore/CombiningClass.pl (or unicode/CombiningClass.pl)
  64 - unicore/Decomposition.pl (or unicode/Decomposition.pl)
  65
  66 NOTES
  67
  68 (1) After these unicore/*.* files are updated:
  69
  70 In the case of XSUB:
  71     You must rebuild the module,
  72     as the data will be compiled on building.
  73
  74 In the case of pure perl:
  75     Rebuilding is not necessary,
  76     as the data will be read on requirement.
  77
  78 (2) Normalize.pmN (a pure perl module) may work without any other file
  79     in this distribution.  It must be renamed Normalize.pm, though.
  80
  81 COPYRIGHT AND LICENSE
  82
  83 SADAHIRO Tomoyuki <SADAHIRO@cpan.org>
  84
  85 Copyright(C) 2001-2011, SADAHIRO Tomoyuki. Japan. All rights reserved.
  86
  87 This module is free software; you can redistribute it and/or
  88 modify it under the same terms as Perl itself.