=head1 heading
=head2 heading
+ =head3 heading
+ =head4 heading
=item text
=over N
=back
=item =head2
-Head1 and head2 produce first and second level headings, with the text in
-the same paragraph as the "=headn" directive forming the heading description.
+=item =head3
+
+=item =head4
+
+Head1, head2, head3 and head4 produce first, second, third and fourth
+level headings, with the text in the same paragraph as the "=headn"
+directive forming the heading description.
=item =over
section specifically for the generation of a list using "=item" commands. At
the end of your list, use "=back" to end it. You will probably want to give
"4" as the number to "=over", as some formatters will use this for indentation.
-This should probably be a default. Note also that there are some basic rules
-to using =item: don't use them outside of an =over/=back block, use at least
-one inside an =over/=back block, you don't _have_ to include the =back if
-the list just runs off the document, and perhaps most importantly, keep the
-items consistent: either use "=item *" for all of them, to produce bullets,
-or use "=item 1.", "=item 2.", etc., to produce numbered lists, or use
-"=item foo", "=item bar", etc., i.e., things that looks nothing like bullets
-or numbers. If you start with bullets or numbers, stick with them, as many
-formatters use the first "=item" type to decide how to format the list.
+The unit of indentation is optional. If the unit is not given the natural
+indentation of the formatting system applied will be used. Note also that
+there are some basic rules to using =item: don't use them outside of
+an =over/=back block, use at least one inside an =over/=back block, you don't
+_have_ to include the =back if the list just runs off the document, and
+perhaps most importantly, keep the items consistent: either use "=item *" for
+all of them, to produce bullets, or use "=item 1.", "=item 2.", etc., to
+produce numbered lists, or use "=item foo", "=item bar", etc., i.e., things
+that looks nothing like bullets or numbers. If you start with bullets or
+numbers, stick with them, as many formatters use the first "=item" type to
+decide how to format the list.
=item =for
justified. Certain interior sequences are recognized both
here and in commands:
- I<text> italicize text, used for emphasis or variables
- B<text> embolden text, used for switches and programs
- S<text> text contains non-breaking spaces
- C<code> literal code
+ I<text> Italicize text, used for emphasis or variables
+ B<text> Embolden text, used for switches and programs
+ S<text> Text contains non-breaking spaces
+ C<code> Render code in a typewriter font, or give some other
+ indication that this represents program text
L<name> A link (cross reference) to name
L<name> manual page
L<name/ident> item in manual page
=item *
-The script F<pod/checkpods.PL> in the Perl source distribution
-provides skeletal checking for lines that look empty but aren't
-B<only>, but is there as a placeholder until someone writes
-Pod::Checker. The best way to check your pod is to pass it through
+The B<podchecker> command is provided to check pod syntax
+for errors and warnings. For example, it checks for completely
+blank lines in pod segments and for unknown escape sequences.
+It is still advised to pass it through
one or more translators and proofread the result, or print out the
result and proofread that. Some of the problems found may be bugs in
the translators, which you may or may not wish to work around.
=head1 SEE ALSO
-L<pod2man> and L<perlsyn/"PODs: Embedded Documentation">
+L<pod2man>, L<perlsyn/"PODs: Embedded Documentation">,
+L<podchecker>
=head1 AUTHOR
projects / p5sagit/p5-mst-13.2.git / blobdiff