external/bsd/bind/dist/contrib/idn/idnkit-1.0-src/tools/runidn/runidn.1

   1 .\"     $NetBSD: runidn.1,v 1.4 2014/12/10 04:37:56 christos Exp $
   2 .\"
   3 .\" Id: runidn.1,v 1.1 2003/06/04 00:27:14 marka Exp
   4 .\"
   5 .\" Copyright (c) 2000,2001 Japan Network Information Center.
   6 .\" All rights reserved.
   7 .\"
   8 .\" By using this file, you agree to the terms and conditions set forth bellow.
   9 .\"
  10 .\"                     LICENSE TERMS AND CONDITIONS
  11 .\"
  12 .\" The following License Terms and Conditions apply, unless a different
  13 .\" license is obtained from Japan Network Information Center ("JPNIC"),
  14 .\" a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
  15 .\" Chiyoda-ku, Tokyo 101-0047, Japan.
  16 .\"
  17 .\" 1. Use, Modification and Redistribution (including distribution of any
  18 .\"    modified or derived work) in source and/or binary forms is permitted
  19 .\"    under this License Terms and Conditions.
  20 .\"
  21 .\" 2. Redistribution of source code must retain the copyright notices as they
  22 .\"    appear in each source code file, this License Terms and Conditions.
  23 .\"
  24 .\" 3. Redistribution in binary form must reproduce the Copyright Notice,
  25 .\"    this License Terms and Conditions, in the documentation and/or other
  26 .\"    materials provided with the distribution.  For the purposes of binary
  27 .\"    distribution the "Copyright Notice" refers to the following language:
  28 .\"    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved."
  29 .\"
  30 .\" 4. The name of JPNIC may not be used to endorse or promote products
  31 .\"    derived from this Software without specific prior written approval of
  32 .\"    JPNIC.
  33 .\"
  34 .\" 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
  35 .\"    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36 .\"    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  37 .\"    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE
  38 .\"    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  39 .\"    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  40 .\"    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  41 .\"    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  42 .\"    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  43 .\"    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  44 .\"    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  45 .\"
  46 .TH RUNIDN 1 "April 6, 2001"
  47 .\"
  48 .SH NAME
  49 runidn \- A script to allow applications to use internationalized domain names.
  50 .\"
  51 .SH SYNOPSIS
  52 \fBrunidn\fP [\fB-e\fP \fIlocal-codeset\fP] \fIprogram-name\fP [\fIargs..\fP]
  53 .\"
  54 .SH DESCRIPTION
  55 \fBrunidn\fP enables applications to use internationalized domain names
  56 without recompilation.
  57 Just add ``runidn'' before the application-name, and the application
  58 can handle non-ASCII domain names.  For example, you can do:
  59 .PP
  60 .RS 4
  61 .nf
  62 \f(CW% runidn telnet \fInon-ASCII-hostname\fR
  63 .fi
  64 .RE
  65 .PP
  66 Before using runidn, you should set up properties related to
  67 internationalized DNS by configuring idnkit's configuration file
  68 \fBidn.conf\fP.
  69 See idn.conf(5) which describes the configuration.
  70 .\"
  71 .SH OPTION
  72 The following option is available:
  73 .TP 4
  74 \fB\-e\fP \fIlocal-codeset\fP
  75 Specify the application's local codeset.
  76 If the option is not specified, \fBrunidn\fR guesses the codeset
  77 from the current locale.
  78 See the ``NOTE'' section for more details about local codeset.
  79 .\"
  80 .SH IMPLEMENTATION
  81 \fBrunidn\fR is a small shell script that sets up an environment variable
  82 called ``LD_PRELOAD'', so that an application dynamically links a shared
  83 library ``libidnkitres'' before any other shared libraries.
  84 .PP
  85 The library ``libidnkitres'' provides a special version of resolver
  86 functions which implement features for handling internationalized
  87 domain names.
  88 \fBrunidn\fR replaces the following functions with the special version:
  89 .PP
  90 .RS 4
  91 .nf
  92 .ft CW
  93 gethostbyname
  94 gethostbyname2
  95 gethostbyaddr
  96 gethostbyname_r
  97 gethostbyname2_r
  98 gethostbyaddr_r
  99 getipnodebyname
 100 getipnodebyaddr
 101 freehostent
 102 getaddrinfo
 103 freeaddrinfo
 104 getnameinfo
 105 .ft R
 106 .fi
 107 .RE
 108 .PP
 109 By overriding them in the standard libraries with the special version
 110 provided by ``libidnkitres'',
 111 \fBrunidn\fR enables applications to use internationalized domain names.
 112 .RS 4
 113 .IP \(bu 2
 114 These API functions accept non-ASCII domain names encoded
 115 in the local codeset that the application is using.
 116 Also the result from these APIs may contain non-ASCII domain names.
 117 .IP \(bu 2
 118 The normalization and codeset conversion between application's local
 119 codeset and the codeset used in DNS protocol data are handled
 120 automatically, so users/applications need not worry about them.
 121 .RE
 122 .PP
 123 Properties of internationalized DNS (such as the normalization or
 124 the codeset used on DNS protocol data) can be configured with the
 125 idnkit's configuration file (\fBidn.conf\fR).
 126 See idn.conf(5) for details.
 127 .\"
 128 .SH NOTE
 129 Unless \fB\-e\fP option is specified, \fBrunidn\fR tries to guess
 130 the application's local codeset from the application's current locale.
 131 However, sometimes it cannot guess the codeset correctly, for example
 132 if the application does not set the locale appropriately by calling
 133 `setlocale()'.
 134 In that case, you can explicitly specify the local codeset by setting an
 135 environment variable ``IDN_LOCAL_CODESET''.
 136 See the section ``LOCAL CODESET'' in idn.conf(5) for details.
 137 .PP
 138 The idea of using ``LD_PRELOAD'' to replace some functions in the standard
 139 library was taken from ``runsocks'' script distributed as part of SOCKS5
 140 reference implementation.
 141 .SH BUGS
 142 There are many cases where \fBrunidn\fR does not work.
 143 .PP
 144 Your system must support ``LD_PRELOAD'' mechanism in the first place.
 145 .PP
 146 Due to security reasons, ``LD_PRELOAD'' mechanism is disabled for
 147 setuid programs in any sane systems.
 148 So \fBrunidn\fR does not work for setuid programs such as ping or rsh.
 149 .PP
 150 If your application uses a function other than the ones runidn supports for
 151 name resolution, you lose.
 152 .SH "SEE ALSO"
 153 idn.conf(5), runsocks(1)