.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Pod::Readme::Plugin::changes 3pm" .TH Pod::Readme::Plugin::changes 3pm "2018-11-26" "perl v5.28.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Pod::Readme::Plugin::changes \- Include latest Changes in README .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& =for readme plugin changes .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a plugin for Pod::Readme that includes the latest release of a \fIChanges\fR file that conforms to the CPAN::Changes::Spec. .SH "ARGUMENTS" .IX Header "ARGUMENTS" Defaults can be overridden with optional arguments. .PP Note that changing arguments may change later calls to this plugin. .ie n .SS """file""" .el .SS "\f(CWfile\fP" .IX Subsection "file" .Vb 1 \& =for readme plugin changes file=\*(AqChanges\*(Aq .Ve .PP If the \fIChanges\fR file has a non-standard name or location in the distribution, you can specify an alternative name. But note that it \&\fImust\fR conform the the CPAN::Changes::Spec. .ie n .SS """heading\-level""" .el .SS "\f(CWheading\-level\fP" .IX Subsection "heading-level" .Vb 1 \& =for readme plugin changes heading\-level=1 .Ve .PP This changes the heading level. (The default is 1.) .ie n .SS """title""" .el .SS "\f(CWtitle\fP" .IX Subsection "title" .Vb 1 \& =for readme plugin changes title=\*(AqRECENT CHANGES\*(Aq .Ve .PP This option allows you to change the title of the heading. .ie n .SS """verbatim""" .el .SS "\f(CWverbatim\fP" .IX Subsection "verbatim" .Vb 1 \& =for readme plugin changes verbatim .Ve .PP If you prefer, you can display a verbatim section of the \fIChanges\fR file. .PP By default, the \fIChanges\fR file will be parsed and reformatted as \s-1POD\s0 (equivalent to the \f(CW\*(C`no\-verbatim\*(C'\fR option).