Subversion Repositories DevTools

Rev

Rev 267 | Rev 5709 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 267 Rev 361
Line 137... Line 137...
137 
#   Documentation
 137 
#   Documentation
138 
#
 138 
#
139 
 
 139 
 
140 
=pod
 140 
=pod
141 
 
 141 
 
- 
 
 142 
=for htmltoc    MAKEUTIL::
- 
 
 143 
 
142 
=head1 NAME
 144 
=head1 NAME
143 
 
 145 
 
144 
gen_winrc.pl - Generate a Windows RC file
 146 
gen_winrc.pl - Generate a Windows RC file
145 
 
 147 
 
146 
=head1 SYNOPSIS
 148 
=head1 SYNOPSIS
Line 166... Line 168...
166 
 
 168 
 
167 
=head1 OPTIONS
 169 
=head1 OPTIONS
168 
 
 170 
 
169 
=over 8
 171 
=over 8
170 
 
 172 
 
171 
=item B<-help>
 173 
=item -help
172 
 
 174 
 
173 
Print a brief help message and exits.
 175 
Print a brief help message and exits.
174 
 
 176 
 
175 
=item B<-help -help>
 177 
=item -help -help
176 
 
 178 
 
177 
Print a detailed help message with an explanation for each option.
 179 
Print a detailed help message with an explanation for each option.
178 
 
 180 
 
179 
=item B<-man>
 181 
=item -man
180 
 
 182 
 
181 
Prints the manual page and exits.
 183 
Prints the manual page and exits.
182 
 
 184 
 
183 
=item B<-verbose>
 185 
=item -verbose
184 
 
 186 
 
185 
Increase the level of debugging information displayed. This option may be used
 187 
Increase the level of debugging information displayed. This option may be used
186 
multiple times.
 188 
multiple times.
187 
 
 189 
 
188 
=item B<-out file>
 190 
=item -out file
189 
 
 191 
 
190 
Specifies the name of the output file. The option is mandatory.
 192 
Specifies the name of the output file. The option is mandatory.
191 
 
 193 
 
192 
=item B<-version nn.nn.nn>
 194 
=item -version nn.nn.nn
193 
 
 195 
 
194 
Specify the version to include include in the resource file. This must be of
 196 
Specify the version to include include in the resource file. This must be of
195 
the form nn.nn.nn, where nn is a decimal digit.
 197 
the form nn.nn.nn, where nn is a decimal digit.
196 
 
 198 
 
197 
Within a JATS makefile the value of $ScmBuildVersion may be used.
 199 
Within a JATS makefile the value of $ScmBuildVersion may be used.
198 
 
 200 
 
199 
The option is mandatory.
 201 
The option is mandatory.
200 
 
 202 
 
201 
=item B<-name string>
 203 
=item -name string
202 
 
 204 
 
203 
Specify the name of the program. The option is mandatory.
 205 
Specify the name of the program. The option is mandatory.
204 
 
 206 
 
205 
Within a JATS makefile the value of $ScmBuildPackage may be used.
 207 
Within a JATS makefile the value of $ScmBuildPackage may be used.
206 
 
 208 
 
207 
=item B<-comment string>
 209 
=item -comment string
208 
 
 210 
 
209 
Specify an optional comment string. If the string contains whitespace then item
 211 
Specify an optional comment string. If the string contains whitespace then item
210 
should be enclosed in quotes.
 212 
should be enclosed in quotes.
211 
 
 213 
 
212 
=item B<-description string>
 214 
=item -description string
213 
 
 215 
 
214 
Specify an optional description string. If the string contains whitespace then item
 216 
Specify an optional description string. If the string contains whitespace then item
215 
should be enclosed in quotes.
 217 
should be enclosed in quotes.
216 
 
 218 
 
217 
=item B<-definitions>
 219 
=item -definitions
218 
 
 220 
 
219 
This option will only write out a file that contains the definitions. The body
 221 
This option will only write out a file that contains the definitions. The body
220 
of the resource script will not be generated. The file that is generated may
 222 
of the resource script will not be generated. The file that is generated may
221 
be included within another resource file.
 223 
be included within another resource file.
222 
 
 224 
 
223 
=item B<-icon filename>
 225 
=item -icon filename
224 
 
 226 
 
225 
This option will add the specified icon file to the resource being created.
 227 
This option will add the specified icon file to the resource being created.
226 
The icon will appear against the DLL.
 228 
The icon will appear against the DLL.
227 
 
 229 
 
228 
=back
 230 
=back
229 
 
 231 
 
230 
=head1 DESCRIPTION
 232 
=head1 DESCRIPTION
231 
 
 233 
 
232 
B<This program> will generate a basic Windows resource file to contains the
 234 
This program will generate a basic Windows resource file that contains the
233 
program name and version number. The resulting file may then be included in
 235 
program name and version number. The resulting file may then be included in
234 
another resource file, or used directly to generate a basic program resource.
 236 
another resource file, or used directly to generate a basic program resource.
235 
 
 237 
 
- 
 
 238 
=for htmlclass Note
- 
 
 239 
 
- 
 
 240 
Note: Use of this utility has been deprecated in favour of the BuildVersion
- 
 
 241 
directive that performs the same operation with a simpler interface.
- 
 
 242 
 
236 
=head1 EXAMPLE
 243 
=head1 EXAMPLE
237 
 
 244 
 
238 
=head2 Used within makefile.pl - Basic
 245 
=head2 Used within makefile.pl - Basic
239 
 
 246 
 
240 
    GenerateFiles ('WIN32', "--Tool=gen_winrc.pl",
 247 
    GenerateFiles ('WIN32', "--Tool=gen_winrc.pl",