Skip to content

Commit 584f021

Browse files
committed
Fix pod2man documentation of --date and --release
Fix the documentation for the date and release options to Pod::Man and the corresponding --date and --release options to pod2man. The positions of the footers controlled by these options were reversed in podlators 1.12 but the documentation was never updated.
1 parent 4367205 commit 584f021

File tree

3 files changed

+25
-23
lines changed

3 files changed

+25
-23
lines changed

Changes

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ v6.1.0 - Not Released
1919
- Fix Pod::Text quoting heuristics for C<> when the contents contains
2020
newlines. Thanks to van-de-bugger for the report. (GitHub #39)
2121

22+
- Fix the documentation for the date and release options to Pod::Man and
23+
the corresponding --date and --release options to pod2man. The positions
24+
of the footers controlled by these options were reversed in podlators
25+
1.12 but the documentation was never updated.
26+
2227
v6.0.2 - 2024-07-14
2328

2429
- Fix removal of scripts/pod2man and scripts/pod2text by make realclean,

lib/Pod/Man.pm

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1764,15 +1764,18 @@ this option is not specified, is C<User Contributed Perl Documentation>.
17641764
17651765
=item date
17661766
1767-
[4.00] Sets the left-hand footer for the C<.TH> macro. If this option is not
1768-
set, the contents of the environment variable POD_MAN_DATE, if set, will be
1769-
used. Failing that, the value of SOURCE_DATE_EPOCH, the modification date of
1770-
the input file, or the current time if stat() can't find that file (which will
1771-
be the case if the input is from C<STDIN>) will be used. If taken from any
1772-
source other than POD_MAN_DATE (which is used verbatim), the date will be
1767+
[4.00] Sets the centered page footer for the C<.TH> macro. If this option is
1768+
not set, the contents of the environment variable POD_MAN_DATE, if set, will
1769+
be used. Failing that, the value of SOURCE_DATE_EPOCH, the modification date
1770+
of the input file, or the current time if stat() can't find that file (which
1771+
will be the case if the input is from C<STDIN>) will be used. If taken from
1772+
any source other than POD_MAN_DATE (which is used verbatim), the date will be
17731773
formatted as C<YYYY-MM-DD> and will be based on UTC (so that the output will
17741774
be reproducible regardless of local time zone).
17751775
1776+
Note that some system C<an> macro sets assume that the centered footer will be
1777+
a modification date and will prepend something like C<Last modified: >.
1778+
17761779
=item encoding
17771780
17781781
[5.00] Specifies the encoding of the output. The value must be an encoding
@@ -1975,14 +1978,10 @@ options is set, C<lquote> or C<rquote> overrides C<quotes>.
19751978
19761979
=item release
19771980
1978-
[1.00] Set the centered footer for the C<.TH> macro. By default, this is set
1979-
to the version of Perl you run Pod::Man under. Setting this to the empty
1980-
string will cause some *roff implementations to use the system default value.
1981-
1982-
Note that some system C<an> macro sets assume that the centered footer will be
1983-
a modification date and will prepend something like C<Last modified: >. If
1984-
this is the case for your target system, you may want to set C<release> to the
1985-
last modified date and C<date> to the version number.
1981+
[1.12] Set the left-hand page footer for the C<.TH> macro. By default, this
1982+
is set to the version of Perl you run Pod::Man under. Setting this to the
1983+
empty string will cause some *roff implementations to use the system default
1984+
value.
19861985
19871986
=item section
19881987

scripts/pod2man.PL

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,15 @@ below.
229229
230230
=item B<-d> I<string>, B<--date>=I<string>
231231
232-
[4.00] Set the left-hand footer string for the C<.TH> macro to I<string>. By
232+
[4.00] Set the centered page footer for the C<.TH> macro to I<string>. By
233233
default, the first of POD_MAN_DATE, SOURCE_DATE_EPOCH, the modification date
234234
of the input file, or the current date (if input comes from C<STDIN>) will be
235-
used, and the date will be in UTC. See L<Pod::Man/CLASS METHODS> for more
235+
used. The default time zone is UTC. See L<Pod::Man/CLASS METHODS> for more
236236
details.
237237
238+
Note that some system C<an> macro sets assume that the centered footer will be
239+
a modification date and will prepend something like C<Last modified: >.
240+
238241
=item B<-e> I<encoding>, B<--encoding>=I<encoding>
239242
240243
[5.00] Specifies the encoding of the output. I<encoding> must be an encoding
@@ -456,16 +459,11 @@ options is set, B<--lquote> or B<--rquote> overrides B<--quotes>.
456459
457460
=item B<-r> I<version>, B<--release>=I<version>
458461
459-
[1.00] Set the centered footer for the C<.TH> macro to I<version>. By
462+
[1.12] Set the left-hand footer for the C<.TH> macro to I<version>. By
460463
default, this is set to the version of Perl you run B<pod2man> under. Setting
461464
this to the empty string will cause some *roff implementations to use the
462465
system default value.
463466
464-
Note that some system C<an> macro sets assume that the centered footer will be
465-
a modification date and will prepend something like C<Last modified: >. If
466-
this is the case for your target system, you may want to set B<--release> to
467-
the last modified date and B<--date> to the version number.
468-
469467
=item B<-s> I<string>, B<--section>=I<string>
470468
471469
[1.00] Set the section for the C<.TH> macro. The standard section numbering
@@ -539,7 +537,7 @@ and Tom Christiansen.
539537
540538
=head1 COPYRIGHT AND LICENSE
541539
542-
Copyright 1999-2001, 2004, 2006, 2008, 2010, 2012-2019, 2022-2024 Russ Allbery
540+
Copyright 1999-2001, 2004, 2006, 2008, 2010, 2012-2019, 2022-2025 Russ Allbery
543541
544542
545543
This program is free software; you may redistribute it and/or modify it

0 commit comments

Comments
 (0)