{
    "mode": "perldoc",
    "parameter": "Pod::Escapes",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AEscapes/json",
    "generated": "2026-06-10T09:21:38Z",
    "synopsis": "use Pod::Escapes qw(e2char);\n...la la la, parsing POD, la la la...\n$text = e2char($enode->label);\nunless(defined $text) {\nprint \"Unknown E sequence \\\"\", $enode->label, \"\\\"!\";\n}\n...else print/interpolate $text...",
    "sections": {
        "NAME": {
            "content": "Pod::Escapes - for resolving Pod E<...> sequences\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "use Pod::Escapes qw(e2char);\n...la la la, parsing POD, la la la...\n$text = e2char($enode->label);\nunless(defined $text) {\nprint \"Unknown E sequence \\\"\", $enode->label, \"\\\"!\";\n}\n...else print/interpolate $text...\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This module provides things that are useful in decoding Pod E<...> sequences. Presumably, it\nshould be used only by Pod parsers and/or formatters.\n\nBy default, Pod::Escapes exports none of its symbols. But you can request any of them to be\nexported. Either request them individually, as with \"use Pod::Escapes qw(symbolname\nsymbolname2...);\", or you can do \"use Pod::Escapes qw(:ALL);\" to get all exportable symbols.\n",
            "subsections": []
        },
        "GOODIES": {
            "content": "",
            "subsections": [
                {
                    "name": "e2char",
                    "content": "Given a name or number that could appear in a \"E<nameornum>\" sequence, this returns the\nstring that it stands for. For example, \"e2char('sol')\", \"e2char('47')\", \"e2char('0x2F')\",\nand \"e2char('057')\" all return \"/\", because \"E<sol>\", \"E<47>\", \"E<0x2f>\", and \"E<057>\", all\nmean \"/\". If the name has no known value (as with a name of \"qacute\") or is syntactically\ninvalid (as with a name of \"1/4\"), this returns undef.\n"
                },
                {
                    "name": "e2charnum",
                    "content": "Given a name or number that could appear in a \"E<nameornum>\" sequence, this returns the\nnumber of the Unicode character that this stands for. For example, \"e2char('sol')\",\n\"e2char('47')\", \"e2char('0x2F')\", and \"e2char('057')\" all return 47, because \"E<sol>\",\n\"E<47>\", \"E<0x2f>\", and \"E<057>\", all mean \"/\", whose Unicode number is 47. If the name has\nno known value (as with a name of \"qacute\") or is syntactically invalid (as with a name of\n\"1/4\"), this returns undef.\n\n$Name2character{*name*}\nMaps from names (as in \"E<*name*>\") like \"eacute\" or \"sol\" to the string that each stands\nfor. Note that this does not include numerics (like \"64\" or \"x981c\"). Under old Perl\nversions (before 5.7) you get a \"?\" in place of characters whose Unicode value is over 255.\n\n$Name2characternumber{*name*}\nMaps from names (as in \"E<*name*>\") like \"eacute\" or \"sol\" to the Unicode value that each\nstands for. For example, $Name2characternumber{'eacute'} is 201, and\n$Name2characternumber{'eacute'} is 8364. You get the correct Unicode value, regardless of\nthe version of Perl you're using -- which differs from %Name2character's behavior under\npre-5.7 Perls.\n\nNote that this hash does not include numerics (like \"64\" or \"x981c\").\n\n$Latin1Codetofallback{*integer*}\nFor numbers in the range 160 (0x00A0) to 255 (0x00FF), this maps from the character code for\na Latin-1 character (like 233 for lowercase e-acute) to the US-ASCII character that best\naproximates it (like \"e\"). You may find this useful if you are rendering POD in a format\nthat you think deals well only with US-ASCII characters.\n\n$Latin1Chartofallback{*character*}\nJust as above, but maps from characters (like \"\\xE9\", lowercase e-acute) to characters (like\n\"e\").\n\n$Code2USASCII{*integer*}\nThis maps from US-ASCII codes (like 32) to the corresponding character (like space, for 32).\nOnly characters 32 to 126 are defined. This is meant for use by \"e2char($x)\" when it senses\nthat it's running on a non-ASCII platform (where chr(32) doesn't get you a space -- but\n$Code2USASCII{32} will). It's documented here just in case you might find it useful.\n"
                }
            ]
        },
        "CAVEATS": {
            "content": "On Perl versions before 5.7, Unicode characters with a value over 255 (like lambda or emdash)\ncan't be conveyed. This module does work under such early Perl versions, but in the place of\neach such character, you get a \"?\". Latin-1 characters (characters 160-255) are unaffected.\n\nUnder EBCDIC platforms, \"e2char($n)\" may not always be the same as \"chr(e2charnum($n))\", and\nditto for $Name2character{$name} and \"chr($Name2characternumber{$name})\", because the strings\nare returned as native, and the numbers are returned as Unicode. However, for Perls starting\nwith v5.8, \"e2char($n)\" is the same as \"chr(utf8::unicodetonative(e2charnum($n)))\", and ditto\nfor $Name2character{$name} and \"chr(utf8::unicodetonative($Name2characternumber{$name}))\".\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Pod::Browser - a pod web server based on Catalyst.\n\nPod::Checker - check pod documents for syntax errors.\n\nPod::Coverage - check if the documentation for a module is comprehensive.\n\nperlpod - description of pod format (for people documenting with pod).\n\nperlpodspec - specification of pod format (for people processing it).\n\nText::Unidecode - ASCII transliteration of Unicode text.\n",
            "subsections": []
        },
        "REPOSITORY": {
            "content": "<https://github.com/neilbowers/Pod-Escapes>\n",
            "subsections": []
        },
        "COPYRIGHT AND DISCLAIMERS": {
            "content": "Copyright (c) 2001-2004 Sean M. Burke. All rights reserved.\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n\nThis program is distributed in the hope that it will be useful, but without any warranty;\nwithout even the implied warranty of merchantability or fitness for a particular purpose.\n\nPortions of the data tables in this module are derived from the entity declarations in the W3C\nXHTML specification.\n\nCurrently (October 2001), that's these three:\n\nhttp://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent\nhttp://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent\nhttp://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Sean M. Burke \"sburke@cpan.org\"\n\nNow being maintained by Neil Bowers <neilb@cpan.org>\n",
            "subsections": []
        }
    },
    "summary": "Pod::Escapes - for resolving Pod E<...> sequences",
    "flags": [],
    "examples": [],
    "see_also": []
}