summaryrefslogtreecommitdiff
path: root/pod/perlpod.pod
diff options
context:
space:
mode:
authorSean M. Burke <sburke@cpan.org>2003-09-06 19:08:28 -0800
committerJarkko Hietaniemi <jhi@iki.fi>2003-09-09 09:50:13 +0000
commita179871ba0a4416951234c6b0cf01884909b8e1f (patch)
tree250c9fdeb56c6791dbd86ea7f770f86bc8b5c147 /pod/perlpod.pod
parent8becbb3b066adee4495175867634bdba48ae2c5d (diff)
downloadperl-a179871ba0a4416951234c6b0cf01884909b8e1f.tar.gz
=encoding in perlpod/perlpodspec
Message-ID: <5.2.1.1.1.20030907030717.00a6aaa0@mailstore.pobox.com> p4raw-id: //depot/perl@21137
Diffstat (limited to 'pod/perlpod.pod')
-rw-r--r--pod/perlpod.pod17
1 files changed, 17 insertions, 0 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod
index 732cdfd626..955d706ef8 100644
--- a/pod/perlpod.pod
+++ b/pod/perlpod.pod
@@ -269,6 +269,23 @@ to signal that the text is not raw data, but instead I<is> Pod text
normal formatting (e.g., may not be a normal-use paragraph, but might
be for formatting as a footnote).
+=item C<=encoding I<encodingname>>
+
+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
+that pod formatters will know how to decode the document. For
+I<encodingname>, use a name recognized by the L<Encode::Supported>
+module. Examples:
+
+ =encoding utf8
+
+ =encoding koi8-r
+
+ =encoding ShiftJIS
+
+ =encoding big5
+
=back
And don't forget, when using any command, that the command lasts up