@@ -55,17 +55,40 @@ For information on what's new in this release, see the
5555F<pod/perldelta.pod> file. For more information about how to find more
5656specific detail about changes, see the Changes file.
5757
58- =head1 DESCRIPTION
58+ =head1 FORMAT OF THIS DOCUMENT
5959
6060This document is written in pod format as an easy way to indicate its
61- structure. The pod format is described in F<pod/perlpod.pod>, but you can
62- read it as is with any pager or editor. Headings and items are marked
63- by lines beginning with '='. The other mark-up used is
61+ structure. On many systems, you can just type
62+
63+ perldoc INSTALL
64+
65+ and get a nicely formatted version. But if not, you can read it as is with any
66+ pager or editor. If you are doing that, here are a few hints. Lines that have
67+ an "=" in column 1 are commands to perldoc. You've already seen lines like
68+
69+ =head1 NAME
70+
71+ This makes a top level heading containing the word "NAME". "=head2" would make
72+ a secondary-level heading, and so forth. Other commands are
6473
65- B<text> embolden text, used for switches, programs or commands
66- C<code> literal code
67- L<name> A link (cross reference) to name
74+ =over increase indentation
75+ =back decrease indentation
76+ =item introduces an item in a list
77+ =for ignore these lines; they are directives to help various
78+ tools, such as creating documentation cross referencing
79+
80+ The stying of text is changed by these in-line mark-up commads
81+
82+ B<text> embolden "text", used for switches, programs or commands
83+ C<code> literal code
84+ L<name> A link (cross reference) to name; you may have to squint
85+ hard to make out the name from other stuff
6886 F<file> A filename
87+ S<text> "text" is output all on the same line
88+
89+ More detail on pod format is given in F<pod/perlpod.pod>.
90+
91+ =head1 DESCRIPTION
6992
7093Although most of the defaults are probably fine for most users,
7194you should probably at least skim through this document before
0 commit comments