[Summary view] [Print] [Text view]

   1  .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
   2  .\"
   3  .\" Standard preamble:
   4  .\" ========================================================================
   5  .de Sh \" Subsection heading
   6  .br
   7  .if t .Sp
   8  .ne 5
   9  .PP
  10  \fB\\$1\fR
  11  .PP
  12  ..
  13  .de Sp \" Vertical space (when we can't use .PP)
  14  .if t .sp .5v
  15  .if n .sp
  16  ..
  17  .de Vb \" Begin verbatim text
  18  .ft CW
  19  .nf
  20  .ne \\$1
  21  ..
  22  .de Ve \" End verbatim text
  23  .ft R
  24  
  25  .fi
  26  ..
  27  .\" Set up some character translations and predefined strings.  \*(-- will
  28  .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  29  .\" double quote, and \*(R" will give a right double quote.  | will give a
  30  .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  31  .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  32  .\" expand to `' in nroff, nothing in troff, for use with C<>.
  33  .tr \(*W-|\(bv\*(Tr
  34  .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  35  .ie n \{\
  36  .    ds -- \(*W-
  37  .    ds PI pi
  38  .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  39  .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  40  .    ds L" ""
  41  .    ds R" ""
  42  .    ds C` ""
  43  .    ds C' ""
  44  'br\}
  45  .el\{\
  46  .    ds -- \|\(em\|
  47  .    ds PI \(*p
  48  .    ds L" ``
  49  .    ds R" ''
  50  'br\}
  51  .\"
  52  .\" If the F register is turned on, we'll generate index entries on stderr for
  53  .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  54  .\" entries marked with X<> in POD.  Of course, you'll have to process the
  55  .\" output yourself in some meaningful fashion.
  56  .if \nF \{\
  57  .    de IX
  58  .    tm Index:\\$1\t\\n%\t"\\$2"
  59  ..
  60  .    nr % 0
  61  .    rr F
  62  .\}
  63  .\"
  64  .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  65  .\" way too many mistakes in technical documents.
  66  .hy 0
  67  .if n .na
  68  .\"
  69  .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  70  .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  71  .    \" fudge factors for nroff and troff
  72  .if n \{\
  73  .    ds #H 0
  74  .    ds #V .8m
  75  .    ds #F .3m
  76  .    ds #[ \f1
  77  .    ds #] \fP
  78  .\}
  79  .if t \{\
  80  .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  81  .    ds #V .6m
  82  .    ds #F 0
  83  .    ds #[ \&
  84  .    ds #] \&
  85  .\}
  86  .    \" simple accents for nroff and troff
  87  .if n \{\
  88  .    ds ' \&
  89  .    ds ` \&
  90  .    ds ^ \&
  91  .    ds , \&
  92  .    ds ~ ~
  93  .    ds /
  94  .\}
  95  .if t \{\
  96  .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  97  .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  98  .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  99  .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 100  .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 101  .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 102  .\}
 103  .    \" troff and (daisy-wheel) nroff accents
 104  .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 105  .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 106  .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 107  .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 108  .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 109  .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 110  .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 111  .ds ae a\h'-(\w'a'u*4/10)'e
 112  .ds Ae A\h'-(\w'A'u*4/10)'E
 113  .    \" corrections for vroff
 114  .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 115  .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 116  .    \" for low resolution devices (crt and lpr)
 117  .if \n(.H>23 .if \n(.V>19 \
 118  \{\
 119  .    ds : e
 120  .    ds 8 ss
 121  .    ds o a
 122  .    ds d- d\h'-1'\(ga
 123  .    ds D- D\h'-1'\(hy
 124  .    ds th \o'bp'
 125  .    ds Th \o'LP'
 126  .    ds ae ae
 127  .    ds Ae AE
 128  .\}
 129  .rm #[ #] #H #V #F C
 130  .\" ========================================================================
 131  .\"
 132  .IX Title "Encode::compat 3"
 133  .TH Encode::compat 3 "2002-12-02" "perl v5.6.1" "User Contributed Perl Documentation"
 134  .UC
 135  .SH "NAME"
 136  Encode::compat \- Encode.pm emulation layer
 137  .SH "VERSION"
 138  .IX Header "VERSION"
 139  This document describes version 0.04 of Encode::compat.
 140  .SH "SYNOPSIS"
 141  .IX Header "SYNOPSIS"
 142  .Vb 2
 143  \&    use Encode::compat; # a no-op for Perl v5.7.1+
 144  \&    use Encode qw(...); # all constants and imports works transparently
 145  .Ve
 146  .Vb 1
 147  \&    # use Encode functions as normal
 148  .Ve
 149  .SH "DESCRIPTION"
 150  .IX Header "DESCRIPTION"
 151  \&\s-1WARNING:\s0 \s-1THIS\s0 \s-1IS\s0 A \s-1PROOF\-OF\-CONCEPT\s0.  Most functions are incomplete.
 152  All implementation details are subject to change!
 153  .PP
 154  This module provide a compatibility layer for \fBEncode.pm\fR users on perl
 155  versions earlier than v5.7.1.  It translates whatever call it receives
 156  into \fBText::Iconv\fR, or (in the future) \fBUnicode::MapUTF8\fR to perform
 157  the actual work.
 158  .PP
 159  The \f(CW\*(C`is_utf8()\*(C'\fR, \f(CW\*(C`_utf8_on()\*(C'\fR and \f(CW\*(C`_utf8_off()\*(C'\fR calls are performed
 160  by the method native to the perl version \*(-- 5.6.1 would use
 161  \&\f(CW\*(C`pack\*(C'\fR/\f(CW\*(C`unpack\*(C'\fR, 5.6.0 uses \f(CW\*(C`tr//CU\*(C'\fR, etc.
 162  .PP
 163  Theoretically, it could be backported to 5.005 and earlier, with none of
 164  the unicode-related semantics available, and serves only as a
 165  abstraction layer above \f(CW\*(C`Text::Iconv\*(C'\fR, \f(CW\*(C`Unicode::MapUTF8\*(C'\fR and possibly
 166  other transcoding modules.
 167  .SH "CAVEATS"
 168  .IX Header "CAVEATS"
 169  Currently, this module only support 5.6.1, and merely provides the three
 170  utility function above (\f(CW\*(C`encode()\*(C'\fR, \f(CW\*(C`decode()\*(C'\fR and \f(CW\*(C`from_to()\*(C'\fR), with
 171  a very kludgy \f(CW\*(C`FB_HTMLCREF\*(C'\fR fallback against \f(CW\*(C`latin\-1\*(C'\fR in
 172  \&\f(CW\*(C`from_to()\*(C'\fR.
 173  .SH "SEE ALSO"
 174  .IX Header "SEE ALSO"
 175  Encode, perlunicode
 176  .SH "AUTHORS"
 177  .IX Header "AUTHORS"
 178  Autrijus Tang <autrijus@autrijus.org>
 179  .SH "COPYRIGHT"
 180  .IX Header "COPYRIGHT"
 181  Copyright 2002 by Autrijus Tang <autrijus@autrijus.org>.
 182  .PP
 183  This program is free software; you can redistribute it and/or 
 184  modify it under the same terms as Perl itself.
 185  .PP
 186  See <http://www.perl.com/perl/misc/Artistic.html>