Debian Codegraph @

upstream/mageia-cauldron/man1/windmc.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "WINDMC 1"
61 .TH WINDMC 1 2025-12-22 binutils-2.45.1 "GNU Development Tools"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 windmc \- generates Windows message resources
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 windmc [options] input\-file
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 \&\fBwindmc\fR reads message definitions from an input file (.mc) and
74 translate them into a set of output files. The output files may be of
75 four kinds:
76 .ie n .IP """h""" 4
77 .el .IP \f(CWh\fR 4
78 .IX Item "h"
79 A C header file containing the message definitions.
80 .ie n .IP """rc""" 4
81 .el .IP \f(CWrc\fR 4
82 .IX Item "rc"
83 A resource file compilable by the \fBwindres\fR tool.
84 .ie n .IP """bin""" 4
85 .el .IP \f(CWbin\fR 4
86 .IX Item "bin"
87 One or more binary files containing the resource data for a specific
88 message language.
89 .ie n .IP """dbg""" 4
90 .el .IP \f(CWdbg\fR 4
91 .IX Item "dbg"
92 A C include file that maps message id\*(Aqs to their symbolic name.
93 .PP
94 The exact description of these different formats is available in
95 documentation from Microsoft.
96 .PP
97 When \fBwindmc\fR converts from the \f(CW\*(C`mc\*(C'\fR format to the \f(CW\*(C`bin\*(C'\fR
98 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
99 Windows Message Compiler.
100 .SH OPTIONS
101 .IX Header "OPTIONS"
102 .IP \fB\-a\fR 4
103 .IX Item "-a"
104 .PD 0
105 .IP \fB\-\-ascii_in\fR 4
106 .IX Item "--ascii_in"
107 .PD
108 Specifies that the input file specified is ASCII. This is the default
109 behaviour.
110 .IP \fB\-A\fR 4
111 .IX Item "-A"
112 .PD 0
113 .IP \fB\-\-ascii_out\fR 4
114 .IX Item "--ascii_out"
115 .PD
116 Specifies that messages in the output \f(CW\*(C`bin\*(C'\fR files should be in ASCII
117 format.
118 .IP \fB\-b\fR 4
119 .IX Item "-b"
120 .PD 0
121 .IP \fB\-\-binprefix\fR 4
122 .IX Item "--binprefix"
123 .PD
124 Specifies that \f(CW\*(C`bin\*(C'\fR filenames should have to be prefixed by the
125 basename of the source file.
126 .IP \fB\-c\fR 4
127 .IX Item "-c"
128 .PD 0
129 .IP \fB\-\-customflag\fR 4
130 .IX Item "--customflag"
131 .PD
132 Sets the customer bit in all message id\*(Aqs.
133 .IP "\fB\-C\fR \fIcodepage\fR" 4
134 .IX Item "-C codepage"
135 .PD 0
136 .IP "\fB\-\-codepage_in\fR \fIcodepage\fR" 4
137 .IX Item "--codepage_in codepage"
138 .PD
139 Sets the default codepage to be used to convert input file to UTF16. The
140 default is ocdepage 1252.
141 .IP \fB\-d\fR 4
142 .IX Item "-d"
143 .PD 0
144 .IP \fB\-\-decimal_values\fR 4
145 .IX Item "--decimal_values"
146 .PD
147 Outputs the constants in the header file in decimal. Default is using
148 hexadecimal output.
149 .IP "\fB\-e\fR \fIext\fR" 4
150 .IX Item "-e ext"
151 .PD 0
152 .IP "\fB\-\-extension\fR \fIext\fR" 4
153 .IX Item "--extension ext"
154 .PD
155 The extension for the header file. The default is .h extension.
156 .IP "\fB\-F\fR \fItarget\fR" 4
157 .IX Item "-F target"
158 .PD 0
159 .IP "\fB\-\-target\fR \fItarget\fR" 4
160 .IX Item "--target target"
161 .PD
162 Specify the BFD format to use for a bin file as output. This
163 is a BFD target name; you can use the \fB\-\-help\fR option to see a list
164 of supported targets. Normally \fBwindmc\fR will use the default
165 format, which is the first one listed by the \fB\-\-help\fR option.
166 .IP "\fB\-h\fR \fIpath\fR" 4
167 .IX Item "-h path"
168 .PD 0
169 .IP "\fB\-\-headerdir\fR \fIpath\fR" 4
170 .IX Item "--headerdir path"
171 .PD
172 The target directory of the generated header file. The default is the
173 current directory.
174 .IP \fB\-H\fR 4
175 .IX Item "-H"
176 .PD 0
177 .IP \fB\-\-help\fR 4
178 .IX Item "--help"
179 .PD
180 Displays a list of command\-line options and then exits.
181 .IP "\fB\-m\fR \fIcharacters\fR" 4
182 .IX Item "-m characters"
183 .PD 0
184 .IP "\fB\-\-maxlength\fR \fIcharacters\fR" 4
185 .IX Item "--maxlength characters"
186 .PD
187 Instructs \fBwindmc\fR to generate a warning if the length
188 of any message exceeds the number specified.
189 .IP \fB\-n\fR 4
190 .IX Item "-n"
191 .PD 0
192 .IP \fB\-\-nullterminate\fR 4
193 .IX Item "--nullterminate"
194 .PD
195 Terminate message text in \f(CW\*(C`bin\*(C'\fR files by zero. By default they are
196 terminated by CR/LF.
197 .IP \fB\-o\fR 4
198 .IX Item "-o"
199 .PD 0
200 .IP \fB\-\-hresult_use\fR 4
201 .IX Item "--hresult_use"
202 .PD
203 Not yet implemented. Instructs \f(CW\*(C`windmc\*(C'\fR to generate an OLE2 header
204 file, using HRESULT definitions. Status codes are used if the flag is not
205 specified.
206 .IP "\fB\-O\fR \fIcodepage\fR" 4
207 .IX Item "-O codepage"
208 .PD 0
209 .IP "\fB\-\-codepage_out\fR \fIcodepage\fR" 4
210 .IX Item "--codepage_out codepage"
211 .PD
212 Sets the default codepage to be used to output text files. The default
213 is ocdepage 1252.
214 .IP "\fB\-r\fR \fIpath\fR" 4
215 .IX Item "-r path"
216 .PD 0
217 .IP "\fB\-\-rcdir\fR \fIpath\fR" 4
218 .IX Item "--rcdir path"
219 .PD
220 The target directory for the generated \f(CW\*(C`rc\*(C'\fR script and the generated
221 \&\f(CW\*(C`bin\*(C'\fR files that the resource compiler script includes. The default
222 is the current directory.
223 .IP \fB\-u\fR 4
224 .IX Item "-u"
225 .PD 0
226 .IP \fB\-\-unicode_in\fR 4
227 .IX Item "--unicode_in"
228 .PD
229 Specifies that the input file is UTF16.
230 .IP \fB\-U\fR 4
231 .IX Item "-U"
232 .PD 0
233 .IP \fB\-\-unicode_out\fR 4
234 .IX Item "--unicode_out"
235 .PD
236 Specifies that messages in the output \f(CW\*(C`bin\*(C'\fR file should be in UTF16
237 format. This is the default behaviour.
238 .IP \fB\-v\fR 4
239 .IX Item "-v"
240 .PD 0
241 .IP \fB\-\-verbose\fR 4
242 .IX Item "--verbose"
243 .PD
244 Enable verbose mode.
245 .IP \fB\-V\fR 4
246 .IX Item "-V"
247 .PD 0
248 .IP \fB\-\-version\fR 4
249 .IX Item "--version"
250 .PD
251 Prints the version number for \fBwindmc\fR.
252 .IP "\fB\-x\fR \fIpath\fR" 4
253 .IX Item "-x path"
254 .PD 0
255 .IP "\fB\-\-xdgb\fR \fIpath\fR" 4
256 .IX Item "--xdgb path"
257 .PD
258 The path of the \f(CW\*(C`dbg\*(C'\fR C include file that maps message id\*(Aqs to the
259 symbolic name. No such file is generated without specifying the switch.
260 .IP \fB@\fR\fIfile\fR 4
261 .IX Item "@file"
262 Read command\-line options from \fIfile\fR. The options read are
263 inserted in place of the original @\fIfile\fR option. If \fIfile\fR
264 does not exist, or cannot be read, then the option will be treated
265 literally, and not removed.
266 .Sp
267 Options in \fIfile\fR are separated by whitespace. A whitespace
268 character may be included in an option by surrounding the entire
269 option in either single or double quotes. Any character (including a
270 backslash) may be included by prefixing the character to be included
271 with a backslash. The \fIfile\fR may itself contain additional
272 @\fIfile\fR options; any such options will be processed recursively.
273 .SH "SEE ALSO"
274 .IX Header "SEE ALSO"
275 the Info entries for \fIbinutils\fR.
276 .SH COPYRIGHT
277 .IX Header "COPYRIGHT"
278 Copyright (c) 1991\-2025 Free Software Foundation, Inc.
279 .PP
280 Permission is granted to copy, distribute and/or modify this document
281 under the terms of the GNU Free Documentation License, Version 1.3
282 or any later version published by the Free Software Foundation;
283 with no Invariant Sections, with no Front\-Cover Texts, and with no
284 Back\-Cover Texts. A copy of the license is included in the
285 section entitled "GNU Free Documentation License".