.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "TIDY_CHANGELOG 1p" .TH TIDY_CHANGELOG 1p 2024-03-02 "perl v5.38.2" "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 tidy_changelog \- command\-line tool for CPAN::Changes .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& $ tidy_changelog Changelog .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Takes a changelog file, parse it using CPAN::Changes and prints out the resulting output. If a file is not given, the program will see if there is one file in the current directory beginning by 'change' (case-insensitive) and, if so, assume it to be the changelog. .SH ARGUMENTS .IX Header "ARGUMENTS" .SS \-\-next .IX Subsection "--next" If provided, assumes that there is a placeholder header for an upcoming next release. The placeholder token is given via \fI\-\-token\fR. .SS \-\-token .IX Subsection "--token" Regular expression to use to detect the token for an upcoming release if \fI\-\-next\fR is used. If not explicitly given, defaults to \f(CW\*(C`\e{\e{\e$NEXT\e}\e}\*(C'\fR. .SS \-\-headers .IX Subsection "--headers" If given, only print out the release header lines, without any of the changes. .SS \-\-reverse .IX Subsection "--reverse" Prints the releases in reverse order (from the oldest to latest). .SS \-\-check .IX Subsection "--check" Only check if the changelog is formatted properly using the changes_file_ok function of Test::CPAN::Changes. .SS \-\-help .IX Subsection "--help" This help