
                         Perl API for idnkit
             -- internationalized domain name toolkit --
                              version 2
               Japan Registry Services Co., Ltd.(JPRS)


Table of contents of this file:

  1. Overview
  2. Components
  3. Build
  4. Sample programs
  5. Documents
  6. Contact information


1. Overview

This package provides Perl API for idnkit, working on Perl version
5.6 and later.  Currently, it supports idnkit version 2 (2.0 and later
versions).

To use this API package, idnkit binary (at least libidnkitlite shared
library) is required.

The latest version of idnkit can be found at:

        http://jprs.co.jp/idn/

Also the latest version of Perl API for idnkit can be found here.


2. Components

This package contains the idnkit modules and sample programs.
The Pod documents are embedded in the source files.


3. Build

Go to the top directory of the source distribution where 'README'
file resides.

Edit 'Makefile.PL' file.  Set $DEFINE, $INC, $LIBS variables to
appropriate values.

	# Cpp flags.
	$DEFINE = '';

	# Includes.
	$INC  = '-I/usr/local/include';

	# Libs
	$LIBS = ['-L/usr/local/lib -lidnkitlite'];

Then, execute 'perl Makefile.PL' to generate Makefiles.

	% perl Makefile.PL

Type 'make' to build the idnkit module.

        % make

Run 'make install' using 'sudo'

	% sudo make install

or try becoming root using 'su' and then run 'make install'.

	% su
	# make install

Run 'make test' to run test programs.

	% make test


4. Sample programs

The following scripts are placed at the 'tools' sub-directory.  They
are sample programs of the idnkit module.

    idnconv.pl
        Tiny 'idnconv' ('idnconv2' in idnkit version 2) command.
	It always works as if '-whole' option is specified.

    idncmp.pl
        Tiny 'idncmp' command.

    idncheck.pl
        Tiny 'idncheck' command.

Those sample programs do not support some options the native commands
have.  For more details about options, execute the sample programs with
'-help' option.


5. Documents

The Pod documents of idnkit modules are embedded in the program files.
After install, type:

	% perldoc IDNKit

to see introduction of the modules.


6. Contact information

The latest version and information about Perl API for idnkit can be
found at:

	http://jprs.co.jp/idn/

Send bug reports and comments to

	idnkit-info@jprs.co.jp
