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 .BI \-\-nls-dir= directory
  49 Specify the directory to search for the NLS files containing the
  50 codepage mapping tables.
  51 .TP
  52 .BR \-o ,\  \-\-output =\fIfile
  53 Output to \fIfile\fR. Default is \fIinputfile.rc\fR.
  54 .TP
  55 .BR \-O ,\  \-\-output\-format =\fIformat
  56 Set the output format. Supported formats are \fBrc\fR (the default),
  57 \fBres\fR, and \fBpot\fR.
  58 .TP
  59 .BR \-P ,\  \-\-po-dir =\fIdirectory
  60 Enable the generation of resource translations based on po files
  61 loaded from the specified directory. That directory must follow the
  62 gettext convention, in particular in must contain one \fI.po\fR file for
  63 each language, and a LINGUAS file listing the available languages.
  64 .TP
  65 .B \-u
  66 Assume that the input file is in Unicode or UTF-8 format and skip
  67 codepage conversions.
  68 .TP
  69 .B \-v
  70 Show all supported codepages and languages.
  71 .TP
  72 .BR \-V ,\  \-\-version
  73 Print version end exit.
  74 .TP
  75 .BR \-W ,\  \-\-pedantic
  76 Enable pedantic warnings.
  77 .SH EXTENSIONS
  78 The original syntax is extended to support codepages more smoothly. Normally,
  79 codepages are based on the DOS codepage from the language setting. The
  80 original syntax only allows the destination codepage to be set. However, this
  81 is not enough for non\-DOS systems which do not use unicode source-files.
  82 .PP
  83 A new keyword \fBCodepages\fR is introduced to set both input and output
  84 codepages to anything one wants for each language. The syntax is similar to
  85 the other constructs:
  86 .PP
  87 Codepages '=' '(' language '=' cpin ':' cpout ... ')'
  88 .PP
  89 The \fIlanguage\fR is the numerical language\-ID or the alias set with
  90 LanguageNames. The input codepage \fIcpin\fR and output codepage
  91 \fIcpout\fR are the numerical codepage IDs. There can be multiple mappings
  92 within the definition and the definition may occur more than once.
  93 .SH AUTHORS
  94 .B wmc
  95 was written by Bertho A. Stultiens.
  96 .SH BUGS
  97 The message compiler should be able to have multiple input files and combine
  98 them into one output file. This would enable the splitting of languages into
  99 separate files.
 100 .PP
 101 Decimal output is completely lacking. Don't know whether it should be
 102 implemented because it is a, well, non-informative format change. It is
 103 recognized on the commandline for some form of compatibility.
 104 .PP
 105 Bugs can be reported on the
 106 .UR https://bugs.winehq.org
 107 .B Wine bug tracker
 108 .UE .
 109 .SH AVAILABILITY
 110 .B wmc
 111 is part of the Wine distribution, which is available through WineHQ,
 112 the
 113 .UR https://www.winehq.org/
 114 .B Wine development headquarters
 115 .UE .
 116 .SH "SEE ALSO"
 117 .BR wine (1),
 118 .BR wrc (1),
 119 .br
 120 .UR https://www.winehq.org/help
 121 .B Wine documentation and support
 122 .UE .