binutils/doc/windmc.1

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