1INI.REPORT(1) User Contributed Perl Documentation INI.REPORT(1)
2
3
4
6 ini.report.pl - Process old-style and new-style Changelog.ini files
7
9 ini.report.pl [options]
10
11 Options:
12 -convert
13 -help
14 -inFileName anInputFileName
15 -outFileName anOutputFileName
16 -pathForHTML aPathForHTML
17 -release aVersionNumber
18 -table
19 -urlForCSS aURLForCSS
20 -version
21 -webPage
22
23 All switches can be reduced to a single letter.
24
25 Exit value: 0.
26
27 Typical switch combinations:
28
29 o No switches
30 Produce a text report on all versions.
31
32 o -c
33 Convert "Changes" to "Changelog.ini".
34
35 Use -c -i CHANGES to read a file called "CHANGES".
36
37 o -r 1.23
38 Produce a text report on a specific version.
39
40 Since -c is not used, -i defaults to "Changelog.ini".
41
42 o -t
43 Produce a HTML report on all versions.
44
45 The report will just be a HTML "table", with CSS for Deploy.Action
46 and Deploy.Reason.
47
48 The table can be embedded in your own web page.
49
50 o -r 1.23 -t
51 Produce a HTML report on a specific version.
52
53 The report will just be a HTML "table", with CSS for Deploy.Action
54 and Deploy.Reason.
55
56 The table can be embedded in your own web page.
57
58 o -w
59 Produce a HTML report on all versions.
60
61 The report will be a HTML "page", with CSS for Deploy.Action and
62 Deploy.Reason.
63
64 o -r 1.23 -w
65 Produce a HTML report on a specific version.
66
67 The report will be a HTML "page", with CSS for Deploy.Action and
68 Deploy.Reason.
69
71 o -convert
72 This specifies that the program is to read an old-style "Changes"
73 file, and is to write a new-style "Changelog.ini" file.
74
75 When -convert is used, the default -inFileName is "Changes", and
76 the default -outFileName is "Changelog.ini".
77
78 o -help
79 Print help and exit.
80
81 o -inFileName anInputFileName
82 The name of a file to be read.
83
84 When the -convert switch is used, -inFileName defaults to
85 "Changes", and -outFileName defaults to "Changelog.ini".
86
87 In the absence of -convert, -inFileName defaults to
88 "Changelog.ini", and -outFileName is not used.
89
90 o -outFileName anOutputFileName
91 The name of a file to be written.
92
93 o -pathForHTML aPathForHTML
94 The path to the HTML::Template-style templates used by the -table
95 and -webPage switches.
96
97 Default:
98 '/usr/share/perl-Module-Metadata-Changes/templates/module/metadata/changes'.
99
100 o -release aVersionNumber
101 Report on a specific release/version.
102
103 If this switch is not used, all versions are reported on.
104
105 o -table
106 Output the report as a HTML table.
107
108 HTML is escaped using "HTML::Entities::Interpolate".
109
110 The table template is called "ini.table.tmpl".
111
112 o -urlForCSS aURLForCSS
113 The URL to insert into the web page, if using the -webPage switch,
114 which points to the CSS for the page.
115
116 Defaults to /.sysassets/css/module/metadata/changes/ini.css.
117
118 o -verbose
119 Print verbose messages.
120
121 o -webPage
122 Output the report as a HTML page.
123
124 The page template is called "ini.page.tmpl".
125
126 This switch automatically activates the -table switch.
127
129 ini.report.pl processes old-style 'Changes' and new-style
130 'Changelog.ini' files.
131
132
133
134perl v5.28.1 2019-02-02 INI.REPORT(1)