binutils/doc/windmc.1

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "WINDMC 1"
 136 .TH WINDMC 1 "2014-12-23" "binutils-2.25" "GNU Development Tools"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 windmc \- generates Windows message resources.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 windmc [options] input-file
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fBwindmc\fR reads message definitions from an input file (.mc) and
 149 translate them into a set of output files.  The output files may be of
 150 four kinds:
 151 .ie n .IP """h""" 4
 152 .el .IP "\f(CWh\fR" 4
 153 .IX Item "h"
 154 A C header file containing the message definitions.
 155 .ie n .IP """rc""" 4
 156 .el .IP "\f(CWrc\fR" 4
 157 .IX Item "rc"
 158 A resource file compilable by the \fBwindres\fR tool.
 159 .ie n .IP """bin""" 4
 160 .el .IP "\f(CWbin\fR" 4
 161 .IX Item "bin"
 162 One or more binary files containing the resource data for a specific
 163 message language.
 164 .ie n .IP """dbg""" 4
 165 .el .IP "\f(CWdbg\fR" 4
 166 .IX Item "dbg"
 167 A C include file that maps message id's to their symbolic name.
 168 .PP
 169 The exact description of these different formats is available in
 170 documentation from Microsoft.
 171 .PP
 172 When \fBwindmc\fR converts from the \f(CW\*(C`mc\*(C'\fR format to the \f(CW\*(C`bin\*(C'\fR
 173 format, \f(CW\*(C`rc\*(C'\fR, \f(CW\*(C`h\*(C'\fR, and optional \f(CW\*(C`dbg\*(C'\fR it is acting like the
 174 Windows Message Compiler.
 175 .SH "OPTIONS"
 176 .IX Header "OPTIONS"
 177 .IP "\fB\-a\fR" 4
 178 .IX Item "-a"
 179 .PD 0
 180 .IP "\fB\-\-ascii_in\fR" 4
 181 .IX Item "--ascii_in"
 182 .PD
 183 Specifies that the input file specified is \s-1ASCII.\s0 This is the default
 184 behaviour.
 185 .IP "\fB\-A\fR" 4
 186 .IX Item "-A"
 187 .PD 0
 188 .IP "\fB\-\-ascii_out\fR" 4
 189 .IX Item "--ascii_out"
 190 .PD
 191 Specifies that messages in the output \f(CW\*(C`bin\*(C'\fR files should be in \s-1ASCII\s0
 192 format.
 193 .IP "\fB\-b\fR" 4
 194 .IX Item "-b"
 195 .PD 0
 196 .IP "\fB\-\-binprefix\fR" 4
 197 .IX Item "--binprefix"
 198 .PD
 199 Specifies that \f(CW\*(C`bin\*(C'\fR filenames should have to be prefixed by the
 200 basename of the source file.
 201 .IP "\fB\-c\fR" 4
 202 .IX Item "-c"
 203 .PD 0
 204 .IP "\fB\-\-customflag\fR" 4
 205 .IX Item "--customflag"
 206 .PD
 207 Sets the customer bit in all message id's.
 208 .IP "\fB\-C\fR \fIcodepage\fR" 4
 209 .IX Item "-C codepage"
 210 .PD 0
 211 .IP "\fB\-\-codepage_in\fR \fIcodepage\fR" 4
 212 .IX Item "--codepage_in codepage"
 213 .PD
 214 Sets the default codepage to be used to convert input file to \s-1UTF16.\s0 The
 215 default is ocdepage 1252.
 216 .IP "\fB\-d\fR" 4
 217 .IX Item "-d"
 218 .PD 0
 219 .IP "\fB\-\-decimal_values\fR" 4
 220 .IX Item "--decimal_values"
 221 .PD
 222 Outputs the constants in the header file in decimal. Default is using
 223 hexadecimal output.
 224 .IP "\fB\-e\fR \fIext\fR" 4
 225 .IX Item "-e ext"
 226 .PD 0
 227 .IP "\fB\-\-extension\fR \fIext\fR" 4
 228 .IX Item "--extension ext"
 229 .PD
 230 The extension for the header file. The default is .h extension.
 231 .IP "\fB\-F\fR \fItarget\fR" 4
 232 .IX Item "-F target"
 233 .PD 0
 234 .IP "\fB\-\-target\fR \fItarget\fR" 4
 235 .IX Item "--target target"
 236 .PD
 237 Specify the \s-1BFD\s0 format to use for a bin file as output.  This
 238 is a \s-1BFD\s0 target name; you can use the \fB\-\-help\fR option to see a list
 239 of supported targets.  Normally \fBwindmc\fR will use the default
 240 format, which is the first one listed by the \fB\-\-help\fR option.
 241 .IP "\fB\-h\fR \fIpath\fR" 4
 242 .IX Item "-h path"
 243 .PD 0
 244 .IP "\fB\-\-headerdir\fR \fIpath\fR" 4
 245 .IX Item "--headerdir path"
 246 .PD
 247 The target directory of the generated header file. The default is the
 248 current directory.
 249 .IP "\fB\-H\fR" 4
 250 .IX Item "-H"
 251 .PD 0
 252 .IP "\fB\-\-help\fR" 4
 253 .IX Item "--help"
 254 .PD
 255 Displays a list of command line options and then exits.
 256 .IP "\fB\-m\fR \fIcharacters\fR" 4
 257 .IX Item "-m characters"
 258 .PD 0
 259 .IP "\fB\-\-maxlength\fR \fIcharacters\fR" 4
 260 .IX Item "--maxlength characters"
 261 .PD
 262 Instructs \fBwindmc\fR to generate a warning if the length
 263 of any message exceeds the number specified.
 264 .IP "\fB\-n\fR" 4
 265 .IX Item "-n"
 266 .PD 0
 267 .IP "\fB\-\-nullterminate\fR" 4
 268 .IX Item "--nullterminate"
 269 .PD
 270 Terminate message text in \f(CW\*(C`bin\*(C'\fR files by zero. By default they are
 271 terminated by \s-1CR/LF.\s0
 272 .IP "\fB\-o\fR" 4
 273 .IX Item "-o"
 274 .PD 0
 275 .IP "\fB\-\-hresult_use\fR" 4
 276 .IX Item "--hresult_use"
 277 .PD
 278 Not yet implemented. Instructs \f(CW\*(C`windmc\*(C'\fR to generate an \s-1OLE2\s0 header
 279 file, using \s-1HRESULT\s0 definitions. Status codes are used if the flag is not
 280 specified.
 281 .IP "\fB\-O\fR \fIcodepage\fR" 4
 282 .IX Item "-O codepage"
 283 .PD 0
 284 .IP "\fB\-\-codepage_out\fR \fIcodepage\fR" 4
 285 .IX Item "--codepage_out codepage"
 286 .PD
 287 Sets the default codepage to be used to output text files. The default
 288 is ocdepage 1252.
 289 .IP "\fB\-r\fR \fIpath\fR" 4
 290 .IX Item "-r path"
 291 .PD 0
 292 .IP "\fB\-\-rcdir\fR \fIpath\fR" 4
 293 .IX Item "--rcdir path"
 294 .PD
 295 The target directory for the generated \f(CW\*(C`rc\*(C'\fR script and the generated
 296 \&\f(CW\*(C`bin\*(C'\fR files that the resource compiler script includes. The default
 297 is the current directory.
 298 .IP "\fB\-u\fR" 4
 299 .IX Item "-u"
 300 .PD 0
 301 .IP "\fB\-\-unicode_in\fR" 4
 302 .IX Item "--unicode_in"
 303 .PD
 304 Specifies that the input file is \s-1UTF16.\s0
 305 .IP "\fB\-U\fR" 4
 306 .IX Item "-U"
 307 .PD 0
 308 .IP "\fB\-\-unicode_out\fR" 4
 309 .IX Item "--unicode_out"
 310 .PD
 311 Specifies that messages in the output \f(CW\*(C`bin\*(C'\fR file should be in \s-1UTF16\s0
 312 format. This is the default behaviour.
 313 .IP "\fB\-v\fR" 4
 314 .IX Item "-v"
 315 .PD 0
 316 .IP "\fB\-\-verbose\fR" 4
 317 .IX Item "--verbose"
 318 .PD
 319 Enable verbose mode.
 320 .IP "\fB\-V\fR" 4
 321 .IX Item "-V"
 322 .PD 0
 323 .IP "\fB\-\-version\fR" 4
 324 .IX Item "--version"
 325 .PD
 326 Prints the version number for \fBwindmc\fR.
 327 .IP "\fB\-x\fR \fIpath\fR" 4
 328 .IX Item "-x path"
 329 .PD 0
 330 .IP "\fB\-\-xdgb\fR \fIpath\fR" 4
 331 .IX Item "--xdgb path"
 332 .PD
 333 The path of the \f(CW\*(C`dbg\*(C'\fR C include file that maps message id's to the
 334 symbolic name. No such file is generated without specifying the switch.
 335 .IP "\fB@\fR\fIfile\fR" 4
 336 .IX Item "@file"
 337 Read command-line options from \fIfile\fR.  The options read are
 338 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
 339 does not exist, or cannot be read, then the option will be treated
 340 literally, and not removed.
 341 .Sp
 342 Options in \fIfile\fR are separated by whitespace.  A whitespace
 343 character may be included in an option by surrounding the entire
 344 option in either single or double quotes.  Any character (including a
 345 backslash) may be included by prefixing the character to be included
 346 with a backslash.  The \fIfile\fR may itself contain additional
 347 @\fIfile\fR options; any such options will be processed recursively.
 348 .SH "SEE ALSO"
 349 .IX Header "SEE ALSO"
 350 the Info entries for \fIbinutils\fR.
 351 .SH "COPYRIGHT"
 352 .IX Header "COPYRIGHT"
 353 Copyright (c) 1991\-2014 Free Software Foundation, Inc.
 354 .PP
 355 Permission is granted to copy, distribute and/or modify this document
 356 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
 357 or any later version published by the Free Software Foundation;
 358 with no Invariant Sections, with no Front-Cover Texts, and with no
 359 Back-Cover Texts.  A copy of the license is included in the
 360 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".