summaryrefslogtreecommitdiff
path: root/pod/perlpod.pod
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2014-12-29 13:57:10 -0700
committerKarl Williamson <khw@cpan.org>2014-12-30 21:18:48 -0700
commita0879bf8a3066bd055931dcc51f2c4f80ec01ffb (patch)
treef5a7185177279137ce59566d60eb7c9a05b85fab /pod/perlpod.pod
parent6dd6e9f9592f7349aa8ad652821e3faf61292a83 (diff)
downloadperl-a0879bf8a3066bd055931dcc51f2c4f80ec01ffb.tar.gz
perlpod: Latin1 pods need an =encoding
Diffstat (limited to 'pod/perlpod.pod')
-rw-r--r--pod/perlpod.pod10
1 files changed, 7 insertions, 3 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod
index 2f531f9c16..12b156b72d 100644
--- a/pod/perlpod.pod
+++ b/pod/perlpod.pod
@@ -282,11 +282,15 @@ be for formatting as a footnote).
X<=encoding> X<encoding>
This command is used for declaring the encoding of a document. Most
-users won't need this; but if your encoding isn't US-ASCII or Latin-1,
-then put a C<=encoding I<encodingname>> command early in the document so
+users won't need this; but if your encoding isn't US-ASCII,
+then put a C<=encoding I<encodingname>> command very early in the document so
that pod formatters will know how to decode the document. For
I<encodingname>, use a name recognized by the L<Encode::Supported>
-module. Examples:
+module. Some pod formatters may try to guess between a Latin-1 versus
+UTF-8 encoding, but they may guess wrong. It's best to be explicit if
+you use anything besides strict ASCII. Examples:
+
+ =encoding latin1
=encoding utf8