{
    "content": [
        {
            "type": "text",
            "text": "# I18N::Collate (perldoc)\n\n**Summary:** I18N::Collate - compare 8-bit scalar data according to the current locale\n\n**Synopsis:** use I18N::Collate;\nsetlocale(LCCOLLATE, 'locale-of-your-choice');\n$s1 = I18N::Collate->new(\"scalardata1\");\n$s2 = I18N::Collate->new(\"scalardata2\");\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (5 lines)\n- **DESCRIPTION** (38 lines)\n\n## Full Content\n\n### NAME\n\nI18N::Collate - compare 8-bit scalar data according to the current locale\n\n### SYNOPSIS\n\nuse I18N::Collate;\nsetlocale(LCCOLLATE, 'locale-of-your-choice');\n$s1 = I18N::Collate->new(\"scalardata1\");\n$s2 = I18N::Collate->new(\"scalardata2\");\n\n### DESCRIPTION\n\n*\n\nWARNING: starting from the Perl version 5.00306\nthe I18N::Collate interface for comparing 8-bit scalar data\naccording to the current locale\n\nHAS BEEN DEPRECATED\n\nThat is, please do not use it anymore for any new applications\nand please migrate the old applications away from it because its\nfunctionality was integrated into the Perl core language in the\nrelease 5.00306.\n\nSee the perllocale manual page for further information.\n\n*\n\nThis module provides you with objects that will collate according to your national character\nset, provided that the POSIX setlocale() function is supported on your system.\n\nYou can compare $s1 and $s2 above with\n\n$s1 le $s2\n\nto extract the data itself, you'll need a dereference: $$s1\n\nThis module uses POSIX::setlocale(). The basic collation conversion is done by strxfrm() which\nterminates at NUL characters being a decent C routine. collatexfrm() handles embedded NUL\ncharacters gracefully.\n\nThe available locales depend on your operating system; try whether \"locale -a\" shows them or man\npages for \"locale\" or \"nlsinfo\" or the direct approach \"ls /usr/lib/nls/loc\" or \"ls\n/usr/lib/nls\" or \"ls /usr/lib/locale\". Not all the locales that your vendor supports are\nnecessarily installed: please consult your operating system's documentation and possibly your\nlocal system administration. The locale names are probably something like \"xxXX.(ISO)?8859-N\"\nor \"xxXX.(ISO)?8859N\", for example \"frCH.ISO8859-1\" is the Swiss (CH) variant of French (fr),\nISO Latin (8859) 1 (-1) which is the Western European character set.\n\n"
        }
    ],
    "structuredContent": {
        "command": "I18N::Collate",
        "section": "",
        "mode": "perldoc",
        "summary": "I18N::Collate - compare 8-bit scalar data according to the current locale",
        "synopsis": "use I18N::Collate;\nsetlocale(LCCOLLATE, 'locale-of-your-choice');\n$s1 = I18N::Collate->new(\"scalardata1\");\n$s2 = I18N::Collate->new(\"scalardata2\");",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 38,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "I18N::Collate - compare 8-bit scalar data according to the current locale\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use I18N::Collate;\nsetlocale(LCCOLLATE, 'locale-of-your-choice');\n$s1 = I18N::Collate->new(\"scalardata1\");\n$s2 = I18N::Collate->new(\"scalardata2\");\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "*\n\nWARNING: starting from the Perl version 5.00306\nthe I18N::Collate interface for comparing 8-bit scalar data\naccording to the current locale\n\nHAS BEEN DEPRECATED\n\nThat is, please do not use it anymore for any new applications\nand please migrate the old applications away from it because its\nfunctionality was integrated into the Perl core language in the\nrelease 5.00306.\n\nSee the perllocale manual page for further information.\n\n*\n\nThis module provides you with objects that will collate according to your national character\nset, provided that the POSIX setlocale() function is supported on your system.\n\nYou can compare $s1 and $s2 above with\n\n$s1 le $s2\n\nto extract the data itself, you'll need a dereference: $$s1\n\nThis module uses POSIX::setlocale(). The basic collation conversion is done by strxfrm() which\nterminates at NUL characters being a decent C routine. collatexfrm() handles embedded NUL\ncharacters gracefully.\n\nThe available locales depend on your operating system; try whether \"locale -a\" shows them or man\npages for \"locale\" or \"nlsinfo\" or the direct approach \"ls /usr/lib/nls/loc\" or \"ls\n/usr/lib/nls\" or \"ls /usr/lib/locale\". Not all the locales that your vendor supports are\nnecessarily installed: please consult your operating system's documentation and possibly your\nlocal system administration. The locale names are probably something like \"xxXX.(ISO)?8859-N\"\nor \"xxXX.(ISO)?8859N\", for example \"frCH.ISO8859-1\" is the Swiss (CH) variant of French (fr),\nISO Latin (8859) 1 (-1) which is the Western European character set.\n",
                "subsections": []
            }
        }
    }
}