ini.report.pl - Process old-style and new-style Changelog.ini files
ini.report.pl [options]
Options: -convert -help -inFileName anInputFileName -outFileName anOutputFileName -pathForHTML aPathForHTML -release aVersionNumber -table -urlForCSS aURLForCSS -version -webPage
All switches can be reduced to a single letter.
Exit value: 0.
Typical switch combinations:
Produce a text report on all versions.
Convert Changes to Changelog.ini.
Changes
Changelog.ini
Use -c -i CHANGES to read a file called CHANGES.
CHANGES
Produce a text report on a specific version.
Since -c is not used, -i defaults to Changelog.ini.
Produce a HTML report on all versions.
The report will just be a HTML table, with CSS for Deploy.Action and Deploy.Reason.
table
The table can be embedded in your own web page.
Produce a HTML report on a specific version.
The report will be a HTML page, with CSS for Deploy.Action and Deploy.Reason.
page
This specifies that the program is to read an old-style Changes file, and is to write a new-style Changelog.ini file.
When -convert is used, the default -inFileName is Changes, and the default -outFileName is Changelog.ini.
Print help and exit.
The name of a file to be read.
When the -convert switch is used, -inFileName defaults to Changes, and -outFileName defaults to Changelog.ini.
In the absence of -convert, -inFileName defaults to Changelog.ini, and -outFileName is not used.
The name of a file to be written.
The path to the HTML::Template-style templates used by the -table and -webPage switches.
Default: '/dev/shm/html/assets/templates/module/metadata/changes'.
Report on a specific release/version.
If this switch is not used, all versions are reported on.
Output the report as a HTML table.
HTML is escaped using HTML::Entities::Interpolate.
HTML::Entities::Interpolate
The table template is called ini.table.tmpl.
ini.table.tmpl
The URL to insert into the web page, if using the -webPage switch, which points to the CSS for the page.
Defaults to /assets/css/module/metadata/changes/ini.css.
Print verbose messages.
Output the report as a HTML page.
The page template is called ini.page.tmpl.
ini.page.tmpl
This switch automatically activates the -table switch.
ini.report.pl processes old-style 'Changes' and new-style 'Changelog.ini' files.
To install Module::Metadata::Changes, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Metadata::Changes
CPAN shell
perl -MCPAN -e shell install Module::Metadata::Changes
For more information on module installation, please visit the detailed CPAN module installation guide.