mingw-5.1.4/win32/man/man1/windres.1
changeset 0 76b1f169d9fe
equal deleted inserted replaced
-1:000000000000 0:76b1f169d9fe
       
     1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
       
     2 .\"
       
     3 .\" Standard preamble:
       
     4 .\" ========================================================================
       
     5 .de Sh \" Subsection heading
       
     6 .br
       
     7 .if t .Sp
       
     8 .ne 5
       
     9 .PP
       
    10 \fB\\$1\fR
       
    11 .PP
       
    12 ..
       
    13 .de Sp \" Vertical space (when we can't use .PP)
       
    14 .if t .sp .5v
       
    15 .if n .sp
       
    16 ..
       
    17 .de Vb \" Begin verbatim text
       
    18 .ft CW
       
    19 .nf
       
    20 .ne \\$1
       
    21 ..
       
    22 .de Ve \" End verbatim text
       
    23 .ft R
       
    24 .fi
       
    25 ..
       
    26 .\" Set up some character translations and predefined strings.  \*(-- will
       
    27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
       
    28 .\" double quote, and \*(R" will give a right double quote.  | will give a
       
    29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
       
    30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
       
    31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
       
    32 .tr \(*W-|\(bv\*(Tr
       
    33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
       
    34 .ie n \{\
       
    35 .    ds -- \(*W-
       
    36 .    ds PI pi
       
    37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
       
    38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
       
    39 .    ds L" ""
       
    40 .    ds R" ""
       
    41 .    ds C` ""
       
    42 .    ds C' ""
       
    43 'br\}
       
    44 .el\{\
       
    45 .    ds -- \|\(em\|
       
    46 .    ds PI \(*p
       
    47 .    ds L" ``
       
    48 .    ds R" ''
       
    49 'br\}
       
    50 .\"
       
    51 .\" If the F register is turned on, we'll generate index entries on stderr for
       
    52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
       
    53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
       
    54 .\" output yourself in some meaningful fashion.
       
    55 .if \nF \{\
       
    56 .    de IX
       
    57 .    tm Index:\\$1\t\\n%\t"\\$2"
       
    58 ..
       
    59 .    nr % 0
       
    60 .    rr F
       
    61 .\}
       
    62 .\"
       
    63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
       
    64 .\" way too many mistakes in technical documents.
       
    65 .hy 0
       
    66 .\"
       
    67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
       
    68 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
       
    69 .    \" fudge factors for nroff and troff
       
    70 .if n \{\
       
    71 .    ds #H 0
       
    72 .    ds #V .8m
       
    73 .    ds #F .3m
       
    74 .    ds #[ \f1
       
    75 .    ds #] \fP
       
    76 .\}
       
    77 .if t \{\
       
    78 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
       
    79 .    ds #V .6m
       
    80 .    ds #F 0
       
    81 .    ds #[ \&
       
    82 .    ds #] \&
       
    83 .\}
       
    84 .    \" simple accents for nroff and troff
       
    85 .if n \{\
       
    86 .    ds ' \&
       
    87 .    ds ` \&
       
    88 .    ds ^ \&
       
    89 .    ds , \&
       
    90 .    ds ~ ~
       
    91 .    ds /
       
    92 .\}
       
    93 .if t \{\
       
    94 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
       
    95 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
       
    96 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
       
    97 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
       
    98 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
       
    99 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
       
   100 .\}
       
   101 .    \" troff and (daisy-wheel) nroff accents
       
   102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
       
   103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
       
   104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
       
   105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
       
   106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
       
   107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
       
   108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
       
   109 .ds ae a\h'-(\w'a'u*4/10)'e
       
   110 .ds Ae A\h'-(\w'A'u*4/10)'E
       
   111 .    \" corrections for vroff
       
   112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
       
   113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
       
   114 .    \" for low resolution devices (crt and lpr)
       
   115 .if \n(.H>23 .if \n(.V>19 \
       
   116 \{\
       
   117 .    ds : e
       
   118 .    ds 8 ss
       
   119 .    ds o a
       
   120 .    ds d- d\h'-1'\(ga
       
   121 .    ds D- D\h'-1'\(hy
       
   122 .    ds th \o'bp'
       
   123 .    ds Th \o'LP'
       
   124 .    ds ae ae
       
   125 .    ds Ae AE
       
   126 .\}
       
   127 .rm #[ #] #H #V #F C
       
   128 .\" ========================================================================
       
   129 .\"
       
   130 .IX Title "WINDRES 1"
       
   131 .TH WINDRES 1 "2008-01-09" "binutils-2.18.50" "GNU Development Tools"
       
   132 .SH "NAME"
       
   133 windres \- manipulate Windows resources.
       
   134 .SH "SYNOPSIS"
       
   135 .IX Header "SYNOPSIS"
       
   136 windmc [options] input-file
       
   137 windres [options] [input\-file] [output\-file]
       
   138 .SH "DESCRIPTION"
       
   139 .IX Header "DESCRIPTION"
       
   140 \&\fBwindres\fR reads resources from an input file and copies them into
       
   141 an output file.  Either file may be in one of three formats:
       
   142 .ie n .IP """rc""" 4
       
   143 .el .IP "\f(CWrc\fR" 4
       
   144 .IX Item "rc"
       
   145 A text format read by the Resource Compiler.
       
   146 .ie n .IP """res""" 4
       
   147 .el .IP "\f(CWres\fR" 4
       
   148 .IX Item "res"
       
   149 A binary format generated by the Resource Compiler.
       
   150 .ie n .IP """coff""" 4
       
   151 .el .IP "\f(CWcoff\fR" 4
       
   152 .IX Item "coff"
       
   153 A \s-1COFF\s0 object or executable.
       
   154 .PP
       
   155 The exact description of these different formats is available in
       
   156 documentation from Microsoft.
       
   157 .PP
       
   158 When \fBwindres\fR converts from the \f(CW\*(C`rc\*(C'\fR format to the \f(CW\*(C`res\*(C'\fR
       
   159 format, it is acting like the Windows Resource Compiler.  When
       
   160 \&\fBwindres\fR converts from the \f(CW\*(C`res\*(C'\fR format to the \f(CW\*(C`coff\*(C'\fR
       
   161 format, it is acting like the Windows \f(CW\*(C`CVTRES\*(C'\fR program.
       
   162 .PP
       
   163 When \fBwindres\fR generates an \f(CW\*(C`rc\*(C'\fR file, the output is similar
       
   164 but not identical to the format expected for the input.  When an input
       
   165 \&\f(CW\*(C`rc\*(C'\fR file refers to an external filename, an output \f(CW\*(C`rc\*(C'\fR file
       
   166 will instead include the file contents.
       
   167 .PP
       
   168 If the input or output format is not specified, \fBwindres\fR will
       
   169 guess based on the file name, or, for the input file, the file contents.
       
   170 A file with an extension of \fI.rc\fR will be treated as an \f(CW\*(C`rc\*(C'\fR
       
   171 file, a file with an extension of \fI.res\fR will be treated as a
       
   172 \&\f(CW\*(C`res\*(C'\fR file, and a file with an extension of \fI.o\fR or
       
   173 \&\fI.exe\fR will be treated as a \f(CW\*(C`coff\*(C'\fR file.
       
   174 .PP
       
   175 If no output file is specified, \fBwindres\fR will print the resources
       
   176 in \f(CW\*(C`rc\*(C'\fR format to standard output.
       
   177 .PP
       
   178 The normal use is for you to write an \f(CW\*(C`rc\*(C'\fR file, use \fBwindres\fR
       
   179 to convert it to a \s-1COFF\s0 object file, and then link the \s-1COFF\s0 file into
       
   180 your application.  This will make the resources described in the
       
   181 \&\f(CW\*(C`rc\*(C'\fR file available to Windows.
       
   182 .SH "OPTIONS"
       
   183 .IX Header "OPTIONS"
       
   184 .IP "\fB\-i\fR \fIfilename\fR" 4
       
   185 .IX Item "-i filename"
       
   186 .PD 0
       
   187 .IP "\fB\-\-input\fR \fIfilename\fR" 4
       
   188 .IX Item "--input filename"
       
   189 .PD
       
   190 The name of the input file.  If this option is not used, then
       
   191 \&\fBwindres\fR will use the first non-option argument as the input file
       
   192 name.  If there are no non-option arguments, then \fBwindres\fR will
       
   193 read from standard input.  \fBwindres\fR can not read a \s-1COFF\s0 file from
       
   194 standard input.
       
   195 .IP "\fB\-o\fR \fIfilename\fR" 4
       
   196 .IX Item "-o filename"
       
   197 .PD 0
       
   198 .IP "\fB\-\-output\fR \fIfilename\fR" 4
       
   199 .IX Item "--output filename"
       
   200 .PD
       
   201 The name of the output file.  If this option is not used, then
       
   202 \&\fBwindres\fR will use the first non-option argument, after any used
       
   203 for the input file name, as the output file name.  If there is no
       
   204 non-option argument, then \fBwindres\fR will write to standard output.
       
   205 \&\fBwindres\fR can not write a \s-1COFF\s0 file to standard output.  Note,
       
   206 for compatibility with \fBrc\fR the option \fB\-fo\fR is also
       
   207 accepted, but its use is not recommended.
       
   208 .IP "\fB\-J\fR \fIformat\fR" 4
       
   209 .IX Item "-J format"
       
   210 .PD 0
       
   211 .IP "\fB\-\-input\-format\fR \fIformat\fR" 4
       
   212 .IX Item "--input-format format"
       
   213 .PD
       
   214 The input format to read.  \fIformat\fR may be \fBres\fR, \fBrc\fR, or
       
   215 \&\fBcoff\fR.  If no input format is specified, \fBwindres\fR will
       
   216 guess, as described above.
       
   217 .IP "\fB\-O\fR \fIformat\fR" 4
       
   218 .IX Item "-O format"
       
   219 .PD 0
       
   220 .IP "\fB\-\-output\-format\fR \fIformat\fR" 4
       
   221 .IX Item "--output-format format"
       
   222 .PD
       
   223 The output format to generate.  \fIformat\fR may be \fBres\fR,
       
   224 \&\fBrc\fR, or \fBcoff\fR.  If no output format is specified,
       
   225 \&\fBwindres\fR will guess, as described above.
       
   226 .IP "\fB\-F\fR \fItarget\fR" 4
       
   227 .IX Item "-F target"
       
   228 .PD 0
       
   229 .IP "\fB\-\-target\fR \fItarget\fR" 4
       
   230 .IX Item "--target target"
       
   231 .PD
       
   232 Specify the \s-1BFD\s0 format to use for a \s-1COFF\s0 file as input or output.  This
       
   233 is a \s-1BFD\s0 target name; you can use the \fB\-\-help\fR option to see a list
       
   234 of supported targets.  Normally \fBwindres\fR will use the default
       
   235 format, which is the first one listed by the \fB\-\-help\fR option.
       
   236 .IP "\fB\-\-preprocessor\fR \fIprogram\fR" 4
       
   237 .IX Item "--preprocessor program"
       
   238 When \fBwindres\fR reads an \f(CW\*(C`rc\*(C'\fR file, it runs it through the C
       
   239 preprocessor first.  This option may be used to specify the preprocessor
       
   240 to use, including any leading arguments.  The default preprocessor
       
   241 argument is \f(CW\*(C`gcc \-E \-xc\-header \-DRC_INVOKED\*(C'\fR.
       
   242 .IP "\fB\-I\fR \fIdirectory\fR" 4
       
   243 .IX Item "-I directory"
       
   244 .PD 0
       
   245 .IP "\fB\-\-include\-dir\fR \fIdirectory\fR" 4
       
   246 .IX Item "--include-dir directory"
       
   247 .PD
       
   248 Specify an include directory to use when reading an \f(CW\*(C`rc\*(C'\fR file.
       
   249 \&\fBwindres\fR will pass this to the preprocessor as an \fB\-I\fR
       
   250 option.  \fBwindres\fR will also search this directory when looking for
       
   251 files named in the \f(CW\*(C`rc\*(C'\fR file.  If the argument passed to this command
       
   252 matches any of the supported \fIformats\fR (as described in the \fB\-J\fR
       
   253 option), it will issue a deprecation warning, and behave just like the
       
   254 \&\fB\-J\fR option.  New programs should not use this behaviour.  If a
       
   255 directory happens to match a \fIformat\fR, simple prefix it with \fB./\fR
       
   256 to disable the backward compatibility.
       
   257 .IP "\fB\-D\fR \fItarget\fR" 4
       
   258 .IX Item "-D target"
       
   259 .PD 0
       
   260 .IP "\fB\-\-define\fR \fIsym\fR\fB[=\fR\fIval\fR\fB]\fR" 4
       
   261 .IX Item "--define sym[=val]"
       
   262 .PD
       
   263 Specify a \fB\-D\fR option to pass to the preprocessor when reading an
       
   264 \&\f(CW\*(C`rc\*(C'\fR file.
       
   265 .IP "\fB\-U\fR \fItarget\fR" 4
       
   266 .IX Item "-U target"
       
   267 .PD 0
       
   268 .IP "\fB\-\-undefine\fR \fIsym\fR" 4
       
   269 .IX Item "--undefine sym"
       
   270 .PD
       
   271 Specify a \fB\-U\fR option to pass to the preprocessor when reading an
       
   272 \&\f(CW\*(C`rc\*(C'\fR file.
       
   273 .IP "\fB\-r\fR" 4
       
   274 .IX Item "-r"
       
   275 Ignored for compatibility with rc.
       
   276 .IP "\fB\-v\fR" 4
       
   277 .IX Item "-v"
       
   278 Enable verbose mode.  This tells you what the preprocessor is if you
       
   279 didn't specify one.
       
   280 .IP "\fB\-c\fR \fIval\fR" 4
       
   281 .IX Item "-c val"
       
   282 .PD 0
       
   283 .IP "\fB\-\-codepage\fR \fIval\fR" 4
       
   284 .IX Item "--codepage val"
       
   285 .PD
       
   286 Specify the default codepage to use when reading an \f(CW\*(C`rc\*(C'\fR file.
       
   287 \&\fIval\fR should be a hexadecimal prefixed by \fB0x\fR or decimal
       
   288 codepage code. The valid range is from zero up to 0xffff, but the
       
   289 validity of the codepage is host and configuration dependent.
       
   290 .IP "\fB\-l\fR \fIval\fR" 4
       
   291 .IX Item "-l val"
       
   292 .PD 0
       
   293 .IP "\fB\-\-language\fR \fIval\fR" 4
       
   294 .IX Item "--language val"
       
   295 .PD
       
   296 Specify the default language to use when reading an \f(CW\*(C`rc\*(C'\fR file.
       
   297 \&\fIval\fR should be a hexadecimal language code.  The low eight bits are
       
   298 the language, and the high eight bits are the sublanguage.
       
   299 .IP "\fB\-\-use\-temp\-file\fR" 4
       
   300 .IX Item "--use-temp-file"
       
   301 Use a temporary file to instead of using popen to read the output of
       
   302 the preprocessor. Use this option if the popen implementation is buggy
       
   303 on the host (eg., certain non-English language versions of Windows 95 and
       
   304 Windows 98 are known to have buggy popen where the output will instead
       
   305 go the console).
       
   306 .IP "\fB\-\-no\-use\-temp\-file\fR" 4
       
   307 .IX Item "--no-use-temp-file"
       
   308 Use popen, not a temporary file, to read the output of the preprocessor.
       
   309 This is the default behaviour.
       
   310 .IP "\fB\-h\fR" 4
       
   311 .IX Item "-h"
       
   312 .PD 0
       
   313 .IP "\fB\-\-help\fR" 4
       
   314 .IX Item "--help"
       
   315 .PD
       
   316 Prints a usage summary.
       
   317 .IP "\fB\-V\fR" 4
       
   318 .IX Item "-V"
       
   319 .PD 0
       
   320 .IP "\fB\-\-version\fR" 4
       
   321 .IX Item "--version"
       
   322 .PD
       
   323 Prints the version number for \fBwindres\fR.
       
   324 .IP "\fB\-\-yydebug\fR" 4
       
   325 .IX Item "--yydebug"
       
   326 If \fBwindres\fR is compiled with \f(CW\*(C`YYDEBUG\*(C'\fR defined as \f(CW1\fR,
       
   327 this will turn on parser debugging.
       
   328 .IP "\fB@\fR\fIfile\fR" 4
       
   329 .IX Item "@file"
       
   330 Read command-line options from \fIfile\fR.  The options read are
       
   331 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
       
   332 does not exist, or cannot be read, then the option will be treated
       
   333 literally, and not removed.  
       
   334 .Sp
       
   335 Options in \fIfile\fR are separated by whitespace.  A whitespace
       
   336 character may be included in an option by surrounding the entire
       
   337 option in either single or double quotes.  Any character (including a
       
   338 backslash) may be included by prefixing the character to be included
       
   339 with a backslash.  The \fIfile\fR may itself contain additional
       
   340 @\fIfile\fR options; any such options will be processed recursively.
       
   341 .SH "SEE ALSO"
       
   342 .IX Header "SEE ALSO"
       
   343 the Info entries for \fIbinutils\fR.
       
   344 .SH "COPYRIGHT"
       
   345 .IX Header "COPYRIGHT"
       
   346 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
       
   347 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
       
   348 .PP
       
   349 Permission is granted to copy, distribute and/or modify this document
       
   350 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.2
       
   351 or any later version published by the Free Software Foundation;
       
   352 with no Invariant Sections, with no Front-Cover Texts, and with no
       
   353 Back-Cover Texts.  A copy of the license is included in the
       
   354 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".