.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Locale::Codes::LangVar 3pm"
.TH Locale::Codes::LangVar 3pm "2019-03-01" "perl v5.28.1" "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"
Locale::Codes::LangVar \- module for dealing with langvar code sets
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use Locale::Codes::LangVar;
\&
\&   $name = code2langvar(CODE);
\&   $code = langvar2code(NAME);
\&
\&   @codes   = all_langvar_codes();
\&   @names   = all_langvar_names();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides access to langvar code sets.
.PP
Please refer to the Locale::Codes::Types document for a description
of the code sets available.
.PP
Most of the routines take an optional additional argument which
specifies the code set to use. The code set can be specified using the
name of a code set, or the perl constant specified in the above
document.  If not specified, the default code set will be used.
.SH "ROUTINES"
.IX Header "ROUTINES"
All routines in this module call the appropriate method in the
Locale::Codes module, using an object of type: langvar
Please refer to the documentation of the Locale::Codes module
for details about each function.
.PP
The following functions are exported automatically:
.IP "\fBcode2langvar(\s-1CODE\s0 [,CODESET] [,'retired'])\fR" 4
.IX Item "code2langvar(CODE [,CODESET] [,'retired'])"
See \fBcode2name\fR in Locale::Codes
.IP "\fBlangvar2code(\s-1NAME\s0 [,CODESET] [,'retired'])\fR" 4
.IX Item "langvar2code(NAME [,CODESET] [,'retired'])"
See \fBname2code\fR in Locale::Codes
.IP "\fBlangvar_code2code(\s-1CODE ,CODESET ,CODESET2\s0)\fR" 4
.IX Item "langvar_code2code(CODE ,CODESET ,CODESET2)"
See \fBcode2code\fR in Locale::Codes
.IP "\fBall_langvar_codes([\s-1CODESET\s0] [,'retired'])\fR" 4
.IX Item "all_langvar_codes([CODESET] [,'retired'])"
See \fBall_codes\fR in Locale::Codes
.IP "\fBall_langvar_names([\s-1CODESET\s0] [,'retired'])\fR" 4
.IX Item "all_langvar_names([CODESET] [,'retired'])"
See \fBall_names\fR in Locale::Codes
.PP
The following functions are not exported and must be called fully
qualified with the package name:
.IP "\fBLocale::Codes::Langvar::show_errors(\s-1FLAG\s0)\fR" 4
.IX Item "Locale::Codes::Langvar::show_errors(FLAG)"
By default, invalid input will produce empty results, but no errors.  By
passing in a non-zero value of \s-1FLAG,\s0 errors will be produced.
.Sp
See \fBshow_errors\fR in Locale::Codes but note that the default for
the non-OO modules are to \s-1NOT\s0 produce errors.
.IP "\fBLocale::Codes::Langvar::rename_langvar(\s-1CODE ,NEW_NAME\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::rename_langvar(CODE ,NEW_NAME [,CODESET])"
See \fBrename_code\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::add_langvar(\s-1CODE ,NAME\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::add_langvar(CODE ,NAME [,CODESET])"
See \fBadd_code\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::delete_langvar(\s-1CODE\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::delete_langvar(CODE [,CODESET])"
See \fBdelete_code\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::add_langvar_alias(\s-1NAME ,NEW_NAME\s0)\fR" 4
.IX Item "Locale::Codes::Langvar::add_langvar_alias(NAME ,NEW_NAME)"
See \fBadd_alias\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::delete_langvar_alias(\s-1NAME\s0)\fR" 4
.IX Item "Locale::Codes::Langvar::delete_langvar_alias(NAME)"
See \fBdelete_alias\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::rename_langvar_code(\s-1CODE ,NEW_CODE\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::rename_langvar_code(CODE ,NEW_CODE [,CODESET])"
See \fBreplace_code\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::add_langvar_code_alias(\s-1CODE ,NEW_CODE\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::add_langvar_code_alias(CODE ,NEW_CODE [,CODESET])"
See \fBadd_code_alias\fR in Locale::Codes
.IP "\fBLocale::Codes::Langvar::delete_langvar_code_alias(\s-1CODE\s0 [,CODESET])\fR" 4
.IX Item "Locale::Codes::Langvar::delete_langvar_code_alias(CODE [,CODESET])"
See \fBdelete_code_alias\fR in Locale::Codes
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Locale::Codes" 4
.IX Item "Locale::Codes"
The Locale-Codes distribution.
.SH "AUTHOR"
.IX Header "AUTHOR"
See Locale::Codes for full author history.
.PP
Currently maintained by Sullivan Beck (sbeck@cpan.org).
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 1
\&   Copyright (c) 2011\-2019 Sullivan Beck
.Ve
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.