Skip to content

Commit 32ea69d

Browse files
committed
INSTALL: Better describe pod markup; mention perldoc
This gives more complete advice to someone reading this document about how to read it.
1 parent 2f25cdb commit 32ea69d

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

INSTALL

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,46 @@ For information on what's new in this release, see the
5555
F<pod/perldelta.pod> file. For more information about how to find more
5656
specific detail about changes, see the Changes file.
5757

58-
=head1 DESCRIPTION
58+
=begin comment
59+
60+
=head1 FORMAT OF THIS DOCUMENT
5961

6062
This 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
63+
structure. On many systems, you can just type
64+
65+
perldoc INSTALL
66+
67+
and get a nicely formatted version. But if not, you can read it as is with any
68+
pager or editor. If you are doing that, here are a few hints. Lines that have
69+
an "=" in column 1 are commands to perldoc. You've already seen lines like
70+
71+
=head1 NAME
72+
73+
This makes a top level heading containing the word "NAME". "=head2" would make
74+
a secondary-level heading, and so forth. Other commands are
6475

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
76+
=over increase indentation
77+
=back decrease indentation
78+
=item introduces an item in a list
79+
=for ignore these lines; they are directives to help various
80+
tools, such as creating documentation cross referencing
81+
=begin comment ignore this line
82+
=end comment ignore this line
83+
84+
The styling of text is changed by these in-line mark-up commands
85+
86+
B<text> embolden "text", used for switches, programs or commands
87+
C<code> literal code
88+
L<name> A link (cross reference) to name; you may have to squint
89+
hard to make out the name from other stuff
6890
F<file> A filename
91+
S<text> "text" is output all on the same line
92+
93+
More detail on pod format is given in F<pod/perlpod.pod>.
94+
95+
=end comment
96+
97+
=head1 DESCRIPTION
6998

7099
Although most of the defaults are probably fine for most users,
71100
you should probably at least skim through this document before

0 commit comments

Comments
 (0)