Add support for samplers.
[wine/gsoc_dplay.git] / tools / wmc / wmc.man
blobd8da0a81fb164e60185f641cbd16db488fb49bd9
1 .TH WMC 1 "June 12, 2000" "Version 1.0.0" "Wine Message Compiler"
2 .SH NAME
3 wrc \- Wine Message Compiler
4 .SH SYNOPSIS
5 .BI "wmc " "[options] " "[inputfile]"
6 .SH DESCRIPTION
7 .B wmc
8 compiles messages from
9 .B inputfile
10 into FormatMessage[AW] compatible format encapsulated in a resourcescript
11 format.
12 .B wmc
13 outputs the data either in a standard \fB.bin\fR formatted binary
14 file, or can generated inline resource data.
15 .PP
16 .B wmc
17 takes only one \fBinputfile\fR as argument (see \fBBUGS\fR). The
18 \fBinputfile\fR normally has extension \fB.mc\fR. The messages are read from
19 standard input if no inputfile is given. If the outputfile is not specified
20 with \fI-o\fR, then \fBwmc\fR will write the output to \fBinputfile.{rc,h}\fR.
21 The outputfile is named \fBwmc.tab.{rc,h}\fR if no inputfile was given.
22 .SH OPTIONS
23 .TP
24 .I \-B x
25 Set output byte-order x={n[ative], l[ittle], b[ig]}. Default is n[ative].
26 .TP
27 .I \-c
28 Set 'custom-bit' in message-code values.
29 .TP
30 .I \-d
31 NON-FUNCTIONAL; Use decimal values in output
32 .TP
33 .I \-D
34 Set debug flag. This results is a parser trace and a lot of extra messages.
35 .TP
36 .I \-h
37 Print an informative usage message.
38 .TP
39 .I \-H file
40 Write headerfile to \fIfile\fR. Default is \fIinputfile.h\fR.
41 .TP
42 .I \-i
43 Inline messagetable(s). This option skips the generation of all \fI.bin\fR files
44 and writes all output into the \fI.rc\fR file. This encoding is parsable with
45 wrc(1).
46 .TP
47 .I \-o file
48 Output to \fIfile\fR. Default is \fIinputfile.rc\fR.
49 .TP
50 .I \-u
51 Assume that the inputfile is in unicode.
52 .TP
53 .I \-U
54 Write resource output in unicode formatted messagetable(s).
55 .TP
56 .I \-v
57 Show all supported codepages and languages.
58 .TP
59 .I \-V
60 Print version end exit.
61 .TP
62 .I \-W
63 Enable pedantic warnings.
64 .SH EXTENSIONS
65 The original syntax is extended to support codepages more smoothly. Normally,
66 codepages are based on the DOS\-codepage from the language setting. The
67 original syntax only allows the destination codepage to be set. However, this
68 is not enough for non\-DOS systems which do not use unicode source-files.
69 .PP
70 A new keyword \fICodepages\fR is introduced to set both input and output
71 codepages to anything one wants for each language. The syntax is similar to
72 the other constructs:
73 .PP
74 Codepages '=' '(' language '=' cpin ':' cpout ... ')'
75 .PP
76 The \fIlanguage\fR is the numerical language\-ID or the alias set with
77 LanguageNames. The input\-codepage \fIcpin\fR and output\-codepage
78 \fIcpout\fR are the numerical codepage\-IDs. There can be multiple mapping
79 within the definition and the definition may occur more than once.
80 .SH AUTHORS
81 .B wmc
82 was written by Bertho A. Stultiens.
83 .SH BUGS
84 The message compiler should be able to have multiple inputfiles and combine
85 them into one outputfile. This would enable the splitting of languages into
86 separate files.
87 .PP
88 Unicode detection of the input is suboptimal, to say the least. It should
89 recognize byte\-order\-marks (BOM) and decide what to do.
90 .PP
91 Decimal output is completely lacking. Don't know whether it should be
92 implemented because it is a, well, non-informative format change. It is
93 recognized on the commandline for some form of compatibility.
94 .SH AVAILABILITY
95 .B wmc
96 is part of the wine distribution, which is available through
97 WineHQ, the
98 .B wine
99 development headquarters, at
100 .I http://www.winehq.org/.
101 .SH "SEE ALSO"
102 .BR wine (1),
103 .BR wrc (1)