[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::Alias 3"
 133  .TH Encode::compat::Alias 3 "2002-12-02" "perl v5.6.1" "User Contributed Perl Documentation"
 134  .UC
 135  .SH "NAME"
 136  Encode::Alias \- alias definitions to encodings
 137  .SH "SYNOPSIS"
 138  .IX Header "SYNOPSIS"
 139  .Vb 3
 140  \&  use Encode;
 141  \&  use Encode::Alias;
 142  \&  define_alias( newName => ENCODING);
 143  .Ve
 144  .SH "DESCRIPTION"
 145  .IX Header "DESCRIPTION"
 146  Allows newName to be used as an alias for \s-1ENCODING\s0. \s-1ENCODING\s0 may be
 147  either the name of an encoding or an encoding object (as described 
 148  in Encode).
 149  .PP
 150  Currently \fInewName\fR can be specified in the following ways:
 151  .IP "As a simple string." 4
 152  .IX Item "As a simple string."
 153  .PD 0
 154  .IP "As a qr// compiled regular expression, e.g.:" 4
 155  .IX Item "As a qr// compiled regular expression, e.g.:"
 156  .PD
 157  .Vb 1
 158  \&  define_alias( qr/^iso8859-(\ed+)$/i => '"iso-8859-$1"' );
 159  .Ve
 160  In this case, if \fI\s-1ENCODING\s0\fR is not a reference, it is \f(CW\*(C`eval\*(C'\fR\-ed
 161  in order to allow \f(CW$1\fR etc. to be substituted.  The example is one
 162  way to alias names as used in X11 fonts to the \s-1MIME\s0 names for the
 163  iso\-8859\-* family.  Note the double quotes inside the single quotes.
 164  .Sp
 165  If you are using a regex here, you have to use the quotes as shown or
 166  it won't work.  Also note that regex handling is tricky even for the
 167  experienced.  Use it with caution.
 168  .IP "As a code reference, e.g.:" 4
 169  .IX Item "As a code reference, e.g.:"
 170  .Vb 1
 171  \&  define_alias( sub { return /^iso8859-(\ed+)$/i ? "iso-8859-$1" : undef } , '');
 172  .Ve
 173  In this case, \f(CW$_\fR will be set to the name that is being looked up and
 174  \&\fI\s-1ENCODING\s0\fR is passed to the sub as its first argument.  The example
 175  is another way to alias names as used in X11 fonts to the \s-1MIME\s0 names
 176  for the iso\-8859\-* family.
 177  .Sh "Alias overloading"
 178  .IX Subsection "Alias overloading"
 179  You can override predefined aliases by simply applying \fIdefine_alias()\fR.
 180  The new alias is always evaluated first, and when neccessary,
 181  \&\fIdefine_alias()\fR flushes the internal cache to make the new definition
 182  available.
 183  .PP
 184  .Vb 2
 185  \&  # redirect SHIFT_JIS to MS/IBM Code Page 932, which is a
 186  \&  # superset of SHIFT_JIS
 187  .Ve
 188  .Vb 2
 189  \&  define_alias( qr/shift.*jis$/i  => '"cp932"' );
 190  \&  define_alias( qr/sjis$/i        => '"cp932"' );
 191  .Ve
 192  If you want to zap all predefined aliases, you can use
 193  .PP
 194  .Vb 1
 195  \&  Encode::Alias->undef_aliases;
 196  .Ve
 197  to do so.  And
 198  .PP
 199  .Vb 1
 200  \&  Encode::Alias->init_aliases;
 201  .Ve
 202  gets the factory settings back.
 203  .SH "SEE ALSO"
 204  .IX Header "SEE ALSO"
 205  Encode, Encode::Supported