[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Encode::Alias.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Encode::Alias 3"
.TH Encode::Alias 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Encode::Alias \- alias definitions to encodings
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Encode;
\&  use Encode::Alias;
\&  define_alias( newName => ENCODING);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Allows newName to be used as an alias for \s-1ENCODING\s0. \s-1ENCODING\s0 may be
either the name of an encoding or an encoding object (as described 
in Encode).
.PP
Currently \fInewName\fR can be specified in the following ways:
.IP "As a simple string." 4
.IX Item "As a simple string."
.PD 0
.IP "As a qr// compiled regular expression, e.g.:" 4
.IX Item "As a qr// compiled regular expression, e.g.:"
.PD
.Vb 1
\&  define_alias( qr/^iso8859-(\ed+)$/i => '"iso-8859-$1"' );
.Ve
.Sp
In this case, if \fI\s-1ENCODING\s0\fR is not a reference, it is \f(CW\*(C`eval\*(C'\fR\-ed
in order to allow \f(CW$1\fR etc. to be substituted.  The example is one
way to alias names as used in X11 fonts to the \s-1MIME\s0 names for the
iso\-8859\-* family.  Note the double quotes inside the single quotes.
.Sp
If you are using a regex here, you have to use the quotes as shown or
it won't work.  Also note that regex handling is tricky even for the
experienced.  Use it with caution.
.IP "As a code reference, e.g.:" 4
.IX Item "As a code reference, e.g.:"
.Vb 1
\&  define_alias( sub { return /^iso8859-(\ed+)$/i ? "iso-8859-$1" : undef } , '');
.Ve
.Sp
In this case, \f(CW$_\fR will be set to the name that is being looked up and
\&\fI\s-1ENCODING\s0\fR is passed to the sub as its first argument.  The example
is another way to alias names as used in X11 fonts to the \s-1MIME\s0 names
for the iso\-8859\-* family.
.Sh "Alias overloading"
.IX Subsection "Alias overloading"
You can override predefined aliases by simply applying \fIdefine_alias()\fR.
The new alias is always evaluated first, and when neccessary,
\&\fIdefine_alias()\fR flushes the internal cache to make the new definition
available.
.PP
.Vb 2
\&  # redirect SHIFT_JIS to MS/IBM Code Page 932, which is a
\&  # superset of SHIFT_JIS
.Ve
.PP
.Vb 2
\&  define_alias( qr/shift.*jis$/i  => '"cp932"' );
\&  define_alias( qr/sjis$/i        => '"cp932"' );
.Ve
.PP
If you want to zap all predefined aliases, you can use
.PP
.Vb 1
\&  Encode::Alias->undef_aliases;
.Ve
.PP
to do so.  And
.PP
.Vb 1
\&  Encode::Alias->init_aliases;
.Ve
.PP
gets the factory settings back.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Encode, Encode::Supported
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, 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	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Encode::Alias 3"
132	.TH Encode::Alias 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133	.SH "NAME"
134	Encode::Alias \- alias definitions to encodings
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 3
138	\& use Encode;
139	\& use Encode::Alias;
140	\& define_alias( newName => ENCODING);
141	.Ve
142	.SH "DESCRIPTION"
143	.IX Header "DESCRIPTION"
144	Allows newName to be used as an alias for \s-1ENCODING\s0. \s-1ENCODING\s0 may be
145	either the name of an encoding or an encoding object (as described
146	in Encode).
147	.PP
148	Currently \fInewName\fR can be specified in the following ways:
149	.IP "As a simple string." 4
150	.IX Item "As a simple string."
151	.PD 0
152	.IP "As a qr// compiled regular expression, e.g.:" 4
153	.IX Item "As a qr// compiled regular expression, e.g.:"
154	.PD
155	.Vb 1
156	\& define_alias( qr/^iso8859-(\ed+)$/i => '"iso-8859-$1"' );
157	.Ve
158	.Sp
159	In this case, if \fI\s-1ENCODING\s0\fR is not a reference, it is \f(CW\(C`eval\(C'\fR\-ed
160	in order to allow \f(CW$1\fR etc. to be substituted. The example is one
161	way to alias names as used in X11 fonts to the \s-1MIME\s0 names for the
162	iso\-8859\-* family. Note the double quotes inside the single quotes.
163	.Sp
164	If you are using a regex here, you have to use the quotes as shown or
165	it won't work. Also note that regex handling is tricky even for the
166	experienced. Use it with caution.
167	.IP "As a code reference, e.g.:" 4
168	.IX Item "As a code reference, e.g.:"
169	.Vb 1
170	\& define_alias( sub { return /^iso8859-(\ed+)$/i ? "iso-8859-$1" : undef } , '');
171	.Ve
172	.Sp
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	.PP
189	.Vb 2
190	\& define_alias( qr/shift.*jis$/i => '"cp932"' );
191	\& define_alias( qr/sjis$/i => '"cp932"' );
192	.Ve
193	.PP
194	If you want to zap all predefined aliases, you can use
195	.PP
196	.Vb 1
197	\& Encode::Alias->undef_aliases;
198	.Ve
199	.PP
200	to do so. And
201	.PP
202	.Vb 1
203	\& Encode::Alias->init_aliases;
204	.Ve
205	.PP
206	gets the factory settings back.
207	.SH "SEE ALSO"
208	.IX Header "SEE ALSO"
209	Encode, Encode::Supported