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