INI.REPORT(1)

📦
version 2.12 · 2 versions
, in fedora 43

✨ NAME ✨

ini.report.pl — okay so this one processes old-style and new-style Changelog.ini files. That's her whole thing, that's her era, she is a changelog-processing icon and she knows it 💅

🎀 SYNOPSIS 🎀

ini.report.pl [options]

And the options menu, fresh off the press:

-convert
-help
-inFileName anInputFileName
-outFileName anOutputFileName
-pathForHTML aPathForHTML
-release aVersionNumber
-table
-urlForCSS aURLForCSS
-version
-webPage

All switches can be reduced to a single letter. yes bestie, all of them, one letter each, she's not gonna make you type the whole thing out like some kind of villain 😌

Exit value: 0. She always leaves the party clean. No mess, no drama, no weird exit codes. 🫶

🌈 Typical switch combinations

  • No switches — produce a text report on all versions.
  • -c — convert "Changes" to "Changelog.ini".

Use -c -i CHANGES to read a file called "CHANGES".

  • -r 1.23 — produce a text report on a specific version.

Since -c is not used, -i defaults to "Changelog.ini".

  • -t — produce a HTML report on all versions.

The report will just be a HTML "table", with CSS for Deploy.Action and Deploy.Reason.

The table can be embedded in your own web page.

  • -r 1.23 -t — produce a HTML report on a specific version.

The report will just be a HTML "table", with CSS for Deploy.Action and Deploy.Reason.

The table can be embedded in your own web page.

  • -w — produce a HTML report on all versions.

The report will be a HTML "page", with CSS for Deploy.Action and Deploy.Reason.

  • -r 1.23 -w — produce a HTML report on a specific version.

The report will be a HTML "page", with CSS for Deploy.Action and Deploy.Reason.

💖 OPTIONS 💖

  • -convert — this says: bestie, we're reading an old-style "Changes" file and writing a new-style "Changelog.ini" file. Glow-up behavior fr.

When -convert is used, the default -inFileName is "Changes", and the default -outFileName is "Changelog.ini".

  • -help — print help and exit. She will hold your hand and then dip. 🦋
  • -inFileName anInputFileName — 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.

  • -outFileName anOutputFileName — the name of a file to be written. That's it, that's the job. ✨
  • -pathForHTML aPathForHTML — the path to the HTML::Template-style templates used by the -table and -webPage switches.

Default:

/usr/share/perl-Module-Metadata-Changes/templates/module/metadata/changes

  • -release aVersionNumber — report on a specific release/version.

If this switch is not used, all versions are reported on. She's thorough like that, she doesn't do half-measures 💜

  • -table — output the report as a HTML table.

HTML is escaped using HTML::Entities::Interpolate.

The table template is called ini.table.tmpl.

  • -urlForCSS aURLForCSS — the URL to insert into the web page, if using the -webPage switch, which points to the CSS for the page.

Defaults to /.sysassets/css/module/metadata/changes/ini.css.

  • -verbose — print verbose messages. She's a yapper and she's not sorry about it 🗣️
  • -webPage — output the report as a HTML page.

The page template is called ini.page.tmpl.

This switch automatically activates the -table switch. Not me telling you to do two things when one will do 🙈

🌸 DESCRIPTION 🌸

ini.report.pl processes old-style 'Changes' and new-style 'Changelog.ini' files. That's the vibe. That's the whole vibe check. ✅

Okay and before you go — the lil' fine print at the bottom of the original says perl v5.42.0, 2025-07-25, and it lives in section INI.REPORT(1) under User Contributed Perl Documentation. So that's the manual name, that's the version, that's the date, and honestly? She ate. 👑 Go process some changelogs bestie, iykyk 💖

📦 where this page comes from