Unknown discipline ':utf8' w/ maint perl w/o perlio
[p5sagit/p5-mst-13.2.git] / pod / perlpod.pod
index 91cc81a..955d706 100644 (file)
@@ -173,21 +173,21 @@ usually used just when you want to start a Pod block with an ordinary
 paragraph or a verbatim paragraph.  For example:
 
   =item stuff()
-  
+
   This function does stuff.
-  
+
   =cut
-  
+
   sub stuff {
     ...
   }
-  
+
   =pod
-  
+
   Remember to check its return value, as in:
-  
-    stuff() || die "Couldn't do stufF!";
-  
+
+    stuff() || die "Couldn't do stuff!";
+
   =cut
 
 =item C<=begin I<formatname>>
@@ -208,10 +208,10 @@ is meant for formatters that understand the special format
 called I<formatname>.  For example,
 
   =begin html
-  
+
   <hr> <img src="thang.png">
   <p> This is a raw HTML paragraph </p>
-  
+
   =end html
 
 The command "=for I<formatname> I<text...>"
@@ -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
@@ -552,7 +569,7 @@ you could do it like so:
 which is presumably easier to read than the old way:
 
     C<open(X, "E<gt>E<gt>thing.dat") || die $!>
-    C<$foo-E<gt>bar(); >>
+    C<$foo-E<gt>bar();>
 
 This is currently supported by pod2text (Pod::Text), pod2man (Pod::Man),
 and any other pod2xxx or Pod::Xxxx translators that use
@@ -613,7 +630,7 @@ wish to work around.
 =item *
 
 If you're more familiar with writing in HTML than with writing in Pod, you
-can try your hand at writing documentation in simple HTML, and coverting
+can try your hand at writing documentation in simple HTML, and converting
 it to Pod with the experimental L<Pod::HTML2Pod|Pod::HTML2Pod> module,
 (available in CPAN), and looking at the resulting code.  The experimental
 L<Pod::PXML|Pod::PXML> module in CPAN might also be useful.
@@ -626,7 +643,7 @@ line.  Having something like this:
 
  # - - - - - - - - - - - -
  =item $firecracker->boom()
+
  This noisily detonates the firecracker object.
  =cut
  sub boom {
@@ -638,13 +655,13 @@ at all.
 Instead, have it like this:
 
  # - - - - - - - - - - - -
+
  =item $firecracker->boom()
+
  This noisily detonates the firecracker object.
+
  =cut
+
  sub boom {
  ...