tools/wmc/wmc.man.in

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