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