Pod::Escapes - for resolving Pod E<...> sequences

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Pod::Escapes - for resolving Pod E<...> sequences - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Pod::Escapes"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.38.1</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Pod::Escapes">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Pod::Escapes">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Pod::Escapes">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Pod::Escapes">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Pod::Escapes">5.38.2</a> <a class="dropdown-item active" href="/5.38.1/Pod::Escapes">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Pod::Escapes">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Pod::Escapes">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Pod::Escapes">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Pod::Escapes">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Pod::Escapes">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Pod::Escapes">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Pod::Escapes">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Pod::Escapes">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Pod::Escapes">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Pod::Escapes">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Pod::Escapes">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Pod::Escapes">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Pod::Escapes">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Pod::Escapes">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Pod::Escapes">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Pod::Escapes">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Pod::Escapes">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Pod::Escapes">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Pod::Escapes">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Pod::Escapes">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Pod::Escapes">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Pod::Escapes">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Pod::Escapes">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Pod::Escapes">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Pod::Escapes">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Pod::Escapes">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Pod::Escapes">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Pod::Escapes">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Pod::Escapes">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Pod::Escapes">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Pod::Escapes">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Pod::Escapes">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Pod::Escapes">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Pod::Escapes">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Pod::Escapes">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Pod::Escapes">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Pod::Escapes">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Pod::Escapes">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Pod::Escapes">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Pod::Escapes">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Pod::Escapes">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Pod::Escapes">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Pod::Escapes">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Pod::Escapes">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Pod::Escapes">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Pod::Escapes">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Pod::Escapes">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Pod::Escapes">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Pod::Escapes">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Pod::Escapes">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Pod::Escapes">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Pod::Escapes">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Pod::Escapes">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Pod::Escapes">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Pod::Escapes">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Pod::Escapes">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Pod::Escapes">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Pod::Escapes">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Pod::Escapes">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Pod::Escapes">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Pod::Escapes">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Pod::Escapes">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Pod::Escapes">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Pod::Escapes">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Pod::Escapes">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Pod::Escapes">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Pod::Escapes">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Pod::Escapes">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Pod::Escapes">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Pod::Escapes">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Pod::Escapes">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Pod::Escapes">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Pod::Escapes">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Pod::Escapes">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Pod::Escapes">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Pod::Escapes">5.005_01</a> <a class="dropdown-item" href="/5.005/Pod::Escapes">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/Pod::Escapes">blead</a> <a class="dropdown-item" href="/5.41.10/Pod::Escapes">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Pod::Escapes">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Pod::Escapes">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Pod::Escapes">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Pod::Escapes">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Pod::Escapes">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Pod::Escapes">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Pod::Escapes">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Pod::Escapes">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Pod::Escapes">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Pod::Escapes">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Pod::Escapes">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Pod::Escapes">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Pod::Escapes">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Pod::Escapes">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Pod::Escapes">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Pod::Escapes">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Pod::Escapes">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Pod::Escapes">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Pod::Escapes">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Pod::Escapes">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Pod::Escapes">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Pod::Escapes">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Pod::Escapes">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.38.1/perl">Perl</a> <a class="dropdown-item" href="/5.38.1/perlintro">Intro</a> <a class="dropdown-item" href="/5.38.1/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.38.1/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.38.1/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.1/perlop">Operators</a> <a class="dropdown-item" href="/5.38.1/functions">Functions</a> <a class="dropdown-item" href="/5.38.1/variables">Variables</a> <a class="dropdown-item" href="/5.38.1/modules">Modules</a> <a class="dropdown-item" href="/5.38.1/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.1/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.38.1/perlcommunity">Community</a> <a class="dropdown-item" href="/5.38.1/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.38.1/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.38.1/Pod::Escapes">Pod::Escapes</a> <div id="more"> (<a href="/5.38.1/Pod::Escapes.txt">source</a>, <a href="https://metacpan.org/pod/Pod::Escapes">CPAN</a>) </div> <div id="moduleversion">version 1.07</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.38.1. <a href="/Pod::Escapes">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#GOODIES">GOODIES</a> </li> <li> <a class="text-decoration-none" href="#CAVEATS">CAVEATS</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> <li> <a class="text-decoration-none" href="#REPOSITORY">REPOSITORY</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT-AND-DISCLAIMERS">COPYRIGHT AND DISCLAIMERS</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Pod::Escapes - for resolving Pod E<...> sequences</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>use Pod::Escapes qw(e2char); ...la la la, parsing POD, la la la... $text = e2char($e_node->label); unless(defined $text) { print "Unknown E sequence \"", $e_node->label, "\"!"; } ...else print/interpolate $text...</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>This module provides things that are useful in decoding Pod E<...> sequences. Presumably, it should be used only by Pod parsers and/or formatters.</p> <p>By default, Pod::Escapes exports none of its symbols. But you can request any of them to be exported. Either request them individually, as with <code>use Pod::Escapes qw(symbolname symbolname2...);</code>, or you can do <code>use Pod::Escapes qw(:ALL);</code> to get all exportable symbols.</p> <h1 id="GOODIES"><a class="permalink" href="#GOODIES">#</a>GOODIES</h1> <dl> <dt id="e2char($e_content)"><a class="permalink" href="#e2char($e_content)">#</a><a id="e2char"></a><a id="e2char-e_content"></a>e2char($e_content)</dt> <dd> <p>Given a name or number that could appear in a <code>E<name_or_num></code> sequence, this returns the string that it stands for. For example, <code>e2char('sol')</code>, <code>e2char('47')</code>, <code>e2char('0x2F')</code>, and <code>e2char('057')</code> all return "/", because <code>E<sol></code>, <code>E<47></code>, <code>E<0x2f></code>, and <code>E<057></code>, all mean "/". If the name has no known value (as with a name of "qacute") or is syntactically invalid (as with a name of "1/4"), this returns undef.</p> </dd> <dt id="e2charnum($e_content)"><a class="permalink" href="#e2charnum($e_content)">#</a><a id="e2charnum"></a><a id="e2charnum-e_content"></a>e2charnum($e_content)</dt> <dd> <p>Given a name or number that could appear in a <code>E<name_or_num></code> sequence, this returns the number of the Unicode character that this stands for. For example, <code>e2char('sol')</code>, <code>e2char('47')</code>, <code>e2char('0x2F')</code>, and <code>e2char('057')</code> all return 47, because <code>E<sol></code>, <code>E<47></code>, <code>E<0x2f></code>, and <code>E<057></code>, all mean "/", whose Unicode number is 47. If the name has no known value (as with a name of "qacute") or is syntactically invalid (as with a name of "1/4"), this returns undef.</p> </dd> <dt id="$Name2character{name}"><a class="permalink" href="#$Name2character%7Bname%7D">#</a><a id="Name2character-name"></a>$Name2character{<i>name</i>}</dt> <dd> <p>Maps from names (as in <code>E<<i>name</i>></code>) like "eacute" or "sol" to the string that each stands for. Note that this does not include numerics (like "64" or "x981c"). Under old Perl versions (before 5.7) you get a "?" in place of characters whose Unicode value is over 255.</p> </dd> <dt id="$Name2character_number{name}"><a class="permalink" href="#$Name2character_number%7Bname%7D">#</a><a id="Name2character_number-name"></a>$Name2character_number{<i>name</i>}</dt> <dd> <p>Maps from names (as in <code>E<<i>name</i>></code>) like "eacute" or "sol" to the Unicode value that each stands for. For example, <code>$Name2character_number{'eacute'}</code> is 201, and <code>$Name2character_number{'eacute'}</code> is 8364. You get the correct Unicode value, regardless of the version of Perl you're using -- which differs from <code>%Name2character</code>'s behavior under pre-5.7 Perls.</p> <p>Note that this hash does not include numerics (like "64" or "x981c").</p> </dd> <dt id="$Latin1Code_to_fallback{integer}"><a class="permalink" href="#$Latin1Code_to_fallback%7Binteger%7D">#</a><a id="Latin1Code_to_fallback-integer"></a>$Latin1Code_to_fallback{<i>integer</i>}</dt> <dd> <p>For numbers in the range 160 (0x00A0) to 255 (0x00FF), this maps from the character code for a Latin-1 character (like 233 for lowercase e-acute) to the US-ASCII character that best aproximates it (like "e"). You may find this useful if you are rendering POD in a format that you think deals well only with US-ASCII characters.</p> </dd> <dt id="$Latin1Char_to_fallback{character}"><a class="permalink" href="#$Latin1Char_to_fallback%7Bcharacter%7D">#</a><a id="Latin1Char_to_fallback-character"></a>$Latin1Char_to_fallback{<i>character</i>}</dt> <dd> <p>Just as above, but maps from characters (like "\xE9", lowercase e-acute) to characters (like "e").</p> </dd> <dt id="$Code2USASCII{integer}"><a class="permalink" href="#$Code2USASCII%7Binteger%7D">#</a><a id="Code2USASCII-integer"></a>$Code2USASCII{<i>integer</i>}</dt> <dd> <p>This maps from US-ASCII codes (like 32) to the corresponding character (like space, for 32). Only characters 32 to 126 are defined. This is meant for use by <code>e2char($x)</code> when it senses that it's running on a non-ASCII platform (where chr(32) doesn't get you a space -- but $Code2USASCII{32} will). It's documented here just in case you might find it useful.</p> </dd> </dl> <h1 id="CAVEATS"><a class="permalink" href="#CAVEATS">#</a>CAVEATS</h1> <p>On Perl versions before 5.7, Unicode characters with a value over 255 (like lambda or emdash) can't be conveyed. This module does work under such early Perl versions, but in the place of each such character, you get a "?". Latin-1 characters (characters 160-255) are unaffected.</p> <p>Under EBCDIC platforms, <code>e2char($n)</code> may not always be the same as <code>chr(e2charnum($n))</code>, and ditto for <code>$Name2character{$name}</code> and <code>chr($Name2character_number{$name})</code>, because the strings are returned as native, and the numbers are returned as Unicode. However, for Perls starting with v5.8, <code>e2char($n)</code> is the same as <code>chr(utf8::unicode_to_native(e2charnum($n)))</code>, and ditto for <code>$Name2character{$name}</code> and <code>chr(utf8::unicode_to_native($Name2character_number{$name}))</code>.</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p><a href="/5.38.1/Pod::Browser">Pod::Browser</a> - a pod web server based on <a href="/5.38.1/Catalyst">Catalyst</a>.</p> <p><a href="/5.38.1/Pod::Checker">Pod::Checker</a> - check pod documents for syntax errors.</p> <p><a href="/5.38.1/Pod::Coverage">Pod::Coverage</a> - check if the documentation for a module is comprehensive.</p> <p><a href="/5.38.1/perlpod">perlpod</a> - description of pod format (for people documenting with pod).</p> <p><a href="/5.38.1/perlpodspec">perlpodspec</a> - specification of pod format (for people processing it).</p> <p><a href="/5.38.1/Text::Unidecode">Text::Unidecode</a> - ASCII transliteration of Unicode text.</p> <h1 id="REPOSITORY"><a class="permalink" href="#REPOSITORY">#</a>REPOSITORY</h1> <p><a href="https://github.com/neilbowers/Pod-Escapes">https://github.com/neilbowers/Pod-Escapes</a></p> <h1 id="COPYRIGHT-AND-DISCLAIMERS"><a class="permalink" href="#COPYRIGHT-AND-DISCLAIMERS">#</a><a id="COPYRIGHT"></a>COPYRIGHT AND DISCLAIMERS</h1> <p>Copyright (c) 2001-2004 Sean M. Burke. All rights reserved.</p> <p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <p>This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.</p> <p>Portions of the data tables in this module are derived from the entity declarations in the W3C XHTML specification.</p> <p>Currently (October 2001), that's these three:</p> <pre><code class="plaintext">http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent</code></pre> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>Sean M. Burke <code>sburke@cpan.org</code></p> <p>Now being maintained by Neil Bowers <neilb@cpan.org></p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

Pod::Escapes - for resolving Pod E<...> sequences - Perldoc Browser