Skip to content

Commit 86665b0

Browse files
committed
pod2html: Group '*' and 'no*' switches in documentation
As the next step toward unifying the documentation in bin/pod2html and lib/Pod/Html.pm, group the '*' and 'no*' command-line switches to the pod2html utility and then adjust the descriptions of the switches accordingly. There are 5 such instances (example: 'poderrors' and 'nopoderrors') already grouped in this manner in lib/Pod/Html.pm. This commit brings this grouping into bin/pod2html as well. No changes in functionality. Correct one editing error spotted by Tony Cook. For: #20581
1 parent 73dbc82 commit 86665b0

File tree

1 file changed

+19
-41
lines changed

1 file changed

+19
-41
lines changed

ext/Pod-Html/bin/pod2html

Lines changed: 19 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,10 @@ pod2html takes the following arguments:
2828
=item backlink
2929

3030
--backlink
31-
32-
Turn =head1 directives into links pointing to the top of the HTML file.
33-
34-
=item nobacklink
35-
3631
--nobacklink
3732

38-
Do not turn =head1 directives into links pointing to the top of the HTML file
39-
(default behaviour).
33+
Turn =head1 directives into links pointing to the top of the HTML file.
34+
--nobacklink (which is the default behavior) does not create these backlinks.
4035

4136
=item cachedir
4237

@@ -61,15 +56,11 @@ Flush the cache.
6156
=item header
6257

6358
--header
64-
65-
Create header and footer blocks containing the text of the "NAME" section.
66-
67-
=item noheader
68-
6959
--noheader
7060

71-
Do not create header and footer blocks containing the text of the "NAME"
72-
section (default behaviour).
61+
Create header and footer blocks containing the text of the "NAME" section.
62+
--noheader -- which is the default behavior -- does not create header or footer
63+
blocks.
7364

7465
=item help
7566

@@ -105,12 +96,16 @@ Do not pass both this and --htmldir to pod2html; they are mutually exclusive.
10596

10697
Generate an index at the top of the HTML file (default behaviour).
10798

99+
=over 4
100+
108101
=item noindex
109102

110103
--noindex
111104

112105
Do not generate an index at the top of the HTML file.
113106

107+
=back
108+
114109
=item infile
115110

116111
--infile=name
@@ -128,16 +123,11 @@ is specified.
128123
=item poderrors
129124

130125
--poderrors
131-
132-
Include a "POD ERRORS" section in the outfile if there were any POD errors in
133-
the infile (default behaviour).
134-
135-
=item nopoderrors
136-
137126
--nopoderrors
138127

139-
Do not include a "POD ERRORS" section in the outfile if there were any POD
140-
errors in the infile.
128+
Include a "POD ERRORS" section in the outfile if there were any POD errors in
129+
the infile (default behaviour). --nopoderrors does not create this "POD
130+
ERRORS" section.
141131

142132
=item podpath
143133

@@ -155,27 +145,19 @@ Specify the base directory for finding library pods.
155145
=item quiet
156146

157147
--quiet
158-
159-
Don't display mostly harmless warning messages.
160-
161-
=item noquiet
162-
163148
--noquiet
164149

165-
Display mostly harmless warning messages (default behaviour). But this is not
166-
the same as "verbose" mode.
150+
Don't display mostly harmless warning messages. --noquiet -- which is the
151+
default behavior -- I<does> display these mostly harmless warning messages (but
152+
this is not the same as "verbose" mode).
167153

168154
=item recurse
169155

170156
--recurse
171-
172-
Recurse into subdirectories specified in podpath (default behaviour).
173-
174-
=item norecurse
175-
176157
--norecurse
177158

178-
Do not recurse into subdirectories specified in podpath.
159+
Recurse into subdirectories specified in podpath (default behaviour).
160+
--norecurse does not recurse into these subdirectories.
179161

180162
=item title
181163

@@ -186,14 +168,10 @@ Specify the title of the resulting HTML file.
186168
=item verbose
187169

188170
--verbose
189-
190-
Display progress messages.
191-
192-
=item noverbose
193-
194171
--noverbose
195172

196-
Do not display progress messages (default behaviour).
173+
Display progress messages. --noverbose -- which is the default behavior --
174+
does not display these progress messages.
197175

198176
=back
199177

0 commit comments

Comments
 (0)