.\" $Id: idn.conf.5.in,v 1.1.1.1 2003/06/04 00:27:16 marka Exp $".\".\" Copyright (c) 2000,2001 Japan Network Information Center..\" All rights reserved..\"  .\" By using this file, you agree to the terms and conditions set forth bellow..\" .\" 			LICENSE TERMS AND CONDITIONS .\" .\" The following License Terms and Conditions apply, unless a different.\" license is obtained from Japan Network Information Center ("JPNIC"),.\" a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,.\" Chiyoda-ku, Tokyo 101-0047, Japan..\" .\" 1. Use, Modification and Redistribution (including distribution of any.\"    modified or derived work) in source and/or binary forms is permitted.\"    under this License Terms and Conditions..\" .\" 2. Redistribution of source code must retain the copyright notices as they.\"    appear in each source code file, this License Terms and Conditions..\" .\" 3. Redistribution in binary form must reproduce the Copyright Notice,.\"    this License Terms and Conditions, in the documentation and/or other.\"    materials provided with the distribution.  For the purposes of binary.\"    distribution the "Copyright Notice" refers to the following language:.\"    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved.".\" .\" 4. The name of JPNIC may not be used to endorse or promote products.\"    derived from this Software without specific prior written approval of.\"    JPNIC..\" .\" 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC.\"    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT.\"    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A.\"    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE.\"    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR.\"    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF.\"    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR.\"    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,.\"    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR.\"    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF.\"    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES..\".TH idn.conf 5 "Mar 8, 2002".\".SH NAMEidn.conf, .idnrc, idnalias.conf \- configuration files for idnkit library.\".SH SYNOPSIS@sysconfdir@/idn.conf.br~/.idnrc.br@sysconfdir@/idnalias.conf.\".SH DESCRIPTION\fBidn.conf\fR and \fB.idnrc\fR are configuration files for idnkitlibrary which is a toolkit for handling internationalized domain names..PPidnkit library tries to load the user's configuration file ~/.idnrcfirst, and then tries the system configutation file @sysconfdir@/idn.conf.Note that idnkit library loads either, not both..PPTo use internationalized domain names in DNS or other protocols, theymust be converted to an appropriate format before further processing.In idnkit, this conversion process is comprised of the following tasks..IP 1. 3Convert the given domain name in application's local codeset to Unicode,and vice versa..IP 2. 3Map certain characters in the name to period character so that they aretreated as the domain namedelimiter (\fIdelimiter mapping\fR)..IP 3. 3Map certain characters in the name to other characters or chracter sequences,according to a mapping rule determined by its top level domain (TLD)..IP 4. 3Perform NAMEPREP, which is a starndard name preparation process forinternationalized domain names.  This process is composed ofthe tree steps called mapping, normalization, prohibited characterchecking and bidirectional string checking..IP 5. 3Convert the nameprepped name to IDN encoding, which is the standard encodingfor internationalized domain names (also known as ASCII-compatible encoding,ACE), and vice versa..PPThe configuration file specifies the parameters for these tasks, such as:.RS 2.IP \- 2the encoding of internationalized domain names (IDN encoding)..IP \- 2NAMEPREP schemes..RE.\".SH SYNTAXThe configuration file is a simple text files, and each line in the file(other than comment lines, which begin with ``#'', and empty lines)forms an entry of the following format:.PP.RS 4.nf\fIkeyword\fP\ \fIvalue..\fP.fi.RE\.".SH "IDN-ENCODING ENTRY"IDN encoding entry specifies the encoding name (codeset name) whichis used as the encoding of internationalized domain names..PPThe syntax of this entry is:.PP.RS 4.nf\f(CWidn-encoding \fP\fIencoding\fP.fi.RE.PP\fIencoding\fP is the encoding name to be used, and any of the followingnames can be specified..RS 2.IP "\(bu" 2``Punycode''.IP "\(bu" 2``UTF-8''.IP "\(bu" 2Codeset names which iconv_open() library function accepts.  Pleaseconsult iconv() documentation for the available codesets..IP "\(bu" 2Any alias names for the above, defined by the alias file.(See section ``ENCODING-ALIAS-FILE'').RE.PPThe standard encoding was determined as Punycode..\".SH "NAMEPREP ENTRY"Nameprep entry specifies the version of NAMEPREP, which is a specificationof ``canonicalization'' process of internationalized domain name beforeit is converted to the IDN encoding..PPThe syntax of this entry is:.PP.RS 4.nf\f(CWnameprep \fP\fIversion\fP.fi.RE.PP\fIversion\fR is the version name of NAMEPREP specification, and currentlythe following versions can be specified..RS 2.IP "\(bu" 2``RFC3491''.brThis version refers to RFC3491 ``rfc-3491.txt''..RE.PPThe NAMEPREP process consists of the following 4 subprocesses..IP 1. 3mapping, which maps certain characters in a name to other characters,possibly none..IP 2. 3normalization, which replaces character variants in a name toa unique one..IP 3. 3prohibited character checking, which detects invalid characters in a name..IP 4. 3unassigned codepoint checking, which also invalid codepoints in a name..IP 5. 3bidirectional string checking, which detecs invalid string..\".SH "LOCAL-MAP ENTRY"This entry specifies localized mapping phase before NAMEPREP takes place.Different mapping rules can be specified for each TLD (top-level domain).For example, you can have one mapping for ``.tw'' domain, and another for``.jp'' domain..PPThe syntax of this entry is:.PP.RS 4.nf\f(CWlocal-map \fItld\f(CW \fIscheme\fR [\fIscheme\fR..].fi.RE.PP\fItld\fR specifies the TLD to which the mapping rule is to be applied,and \fIscheme\fR specifies the mapping scheme, and currently availableschemes are:.RS 2.TP 4\f(CWRFC3491\fPSpecify mapping defined by RFC3491..TP 4\f(CWfilemap:\fP\fIpathname\fPSpecify mapping defined by the file \fIpathname\fP.See ``MAPFILE FORMAT'' for the format of this file..RE.PPThere are two special \fItld\fRs for specifying the mapping rule forlocal domain names (domain names without any dots in them), and thedefault mapping rule.If\fItld\fR is ``-'', it matches domain names which do not contain anydots.If \fItld\fR is ``.'', it matches any domain names which don't matchto any other mapping rules specified by ``local-map'' entries..\".SH "MAPFILE FORMAT"A mapfile defines a set of character mapping rules.  It can defineunconditional one-character to N-character-sequence (N can be 0, 1 or more)mappings..PPA mapfile is a simple text file, and each line specifies a single mapping.Each line is of the form:.PP.RS 4.nf\fIsrc-codepoint\fR\f(CW; \fImapped-codepoint-seq\fR\f(CW;\fR.fi.RE.PP\fIsrc-codepoint\fR indicates source character of the mapping, and mustbe a Unicode codepoint value in hexadecimal string.\fImapped-codepoint-seq\fR is a sequence of characters which is theoutcome of the mapping, and must be a (possibly empty) list of Unicodecodepoint values in hexadecimal string, separated by spaces..PPLines which begin with ``#'' are treated as comments and ignored..PPA sample mapfile is shown below..PP.RS 4.nf.ft CW# map "A" to "a"0041; 0061;# map "#" to nothing0023; ;# map "@" to "at"0040; 0061 0074;.ft R.fi.RE.\".SH "LOCAL CODESET"\fBidn.conf\fR or \fB~/.idnrc\fR doesn't have an entry to specify thelocal codeset, since it is determined from the application's currentlocale information.So each application can use different local codeset..PPAlthough idnkit tries hard to find out the local codeset, sometimes itfails.  For example, there are applications which use non-ASCII codesetbut work in C locale.  In this case, you can specify the application'slocal codeset by an environment variable ``\fBIDN_LOCAL_CODESET\fR''.Just set the codeset name (or its alias name) to the variable, andidnkit will use the codeset as the local one, regardless of the localesetting..\".SH "ENCODING-ALIAS-FILE"Encoding alias file specifies codeset name aliases.  It is located on@sysconfdir@/idnalias.conf and always loaded automatically as idn.confand .idnrc.  The aliases in this file can be used just as the real names..PPThe alias file is a simple text file, consisting of lines of the form:.PP.RS 4.nf\fIalias-name\fP\ \fIname\fP.fi.RE.PP\fIalias-name\fR is the alias name to be defined, and \fIname\fR isthe real name or another alias name..\".SH "SAMPLE CONFIGURATION"The following shows a sample configuration file..PP.RS 4.ft CW.nf## a sample configuration.## Use Punycode as the IDN encoding.idn-encoding Punycode# Use RFC3491 as NAMEPREP.nameprep RFC3491# Perform Japanese-specific mapping for .jp domain.# assuming /usr/local/lib/idnkit/jp-map contains the mapping.local-map .jp filemap:/usr/local/lib/idnkit/jp-map.fi.ft R.RE.\".SH FILES.I @sysconfdir@/idn.conf.br.I ~/.idnrc.br.I @sysconfdir@/idnalias.conf.br.I @sysconfdir@/idn.conf.sample\- sample configuration with comments.br.I @sysconfdir@/idnalias.conf.sample\- sample alias file.\".SH "SEE ALSO"iconv(3)