.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Cz::Cstocs 3pm"
.TH Cz::Cstocs 3pm "2002-10-17" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Cz::Cstocs \- conversions of charset encodings for the Czech language
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&        use Cz::Cstocs;
\&        my $il2_to_ascii = new Cz::Cstocs \*(Aqil2\*(Aq, \*(Aqascii\*(Aq;
\&        while (<>) {
\&                print &$il2_to_ascii($_);
\&        }
\&
\&        use Cz::Cstocs \*(Aqil2_ascii\*(Aq;
\&        while (<>) {
\&                print il2_ascii($_);
\&        }
\&
\&        use Cz::Cstocs;
\&        sub il2toascii;
\&                # inform the parser that there is a function il2toascii
\&        *il2toascii = new Cz::Cstocs \*(Aqil2\*(Aq, \*(Aqascii\*(Aq;
\&                # now define the function
\&        print il2toascii $data;
\&                # thanks to Jan Krynicky for poining this out
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module helps in converting texts between various charset
encodings, used for Czech and Slovak languages. The instance of the
object \fBCz::Cstocs\fR is created using method \fBnew\fR. It takes at
least two parameters for input and output encoding and can be
afterwards used as a function reference to convert strings/lists.
Cz::Cstocs supports fairly free form of aliases, so iso8859\-2,
\&\s-1ISO\-8859\-2\s0, iso88592 and il2 are all aliases of the same encoding.
For backward compatibility, method \fIconv\fR is supported as well,
so the example above could also read
.PP
.Vb 3
\&        while (<>) {
\&                print $il2_to_ascii\->conv($_);
\&        }
.Ve
.PP
You can also use typeglob syntax.
.PP
The conversion function takes a list and returns list of converted
strings (in the list context) or one string consisting of concatenated
results (in the scalar context).
.PP
You can modify the behaviour of the conversion function by specifying
hash of other options after the encoding names in call to \fBnew\fR.
.IP "fillstring" 4
.IX Item "fillstring"
Gives alternate string that will replace characters from input
encoding that are not present in the output encoding. Default is
space.
.IP "use_accent" 4
.IX Item "use_accent"
Defines whether the accent file should be used. Default is 1 (true).
.IP "nofillstring" 4
.IX Item "nofillstring"
When 1 (true), will keep characters that do not have friends in
accent nor output encoding, will no replace them with fillstring.
Default is 0 except for tex, because you probably rather want to keep
backslashed symbols than loose them.
.IP "cstocsdir" 4
.IX Item "cstocsdir"
Alternate location for encoding and accent files. The default is the
\&\fICz/Cstocs/enc\fR directory in Perl library tree. This location can
also be changed with the \fI\s-1CSTOCSDIR\s0\fR environment variable.
.PP
There is an alternate way to define the conversion function: any
arguments after use Cz::Cstocs that have form encoding_encoding or
encoding_to_encoding are processed and the appropriate functions are
imported. So,
.PP
.Vb 1
\&        use Cz::Cstocs qw(pc2_to_il2 il2_ascii);
.Ve
.PP
define two functions, that are loaded into caller's namespace and
can be used directly. In this case, you cannot specify additional
options, you only have default behaviour.
.SH "ERROR HANDLING"
.IX Header "ERROR HANDLING"
If you request an unknown encoding in the call to new Cz::Cstocs,
the conversion object is not defined and the variable
\&\f(CW$Cz::Cstocs::errstr\fR is set to the error message. When you specify
unknown encoding in the use call style (like \f(CW\*(C`use Cz::Cstocs
\&\*(Aqil2_ascii\*(Aq;\*(C'\fR), the die is called.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jan Pazdziora, adelton@fi.muni.cz, created the module version.
.PP
Jan \*(L"Yenya\*(R" Kasprzak has done the original Un*x implementation.
.SH "VERSION"
.IX Header "VERSION"
3.4
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIcstocs\fR\|(1), \fIperl\fR\|(1), or Xcstocs at
http://www.lut.fi/~kurz/programs/xcstocs.tar.gz.