tools/widl/widl.man.in

   1 .TH WIDL 1 "October 2007" "@PACKAGE_STRING@" "Wine Developers Manual"
   2 .SH NAME
   3 widl \- Wine Interface Definition Language (IDL) compiler
   4 .SH SYNOPSIS
   5 .B widl
   6 [\fIoptions\fR] \fIIDL_file\fR
   7 .br
   8 .B widl
   9 [\fIoptions\fR] \fB--dlldata-only\fR \fIname1\fR [\fIname2\fR...]
  10 .SH DESCRIPTION
  11 When no options are used the program will generate a header file, and possibly
  12 client and server stubs, proxy and dlldata files, a typelib, and a UUID file,
  13 depending on the contents of the IDL file.  If any of the options \fB-c\fR,
  14 \fB-h\fR, \fB-p\fR, \fB-s\fR, \fB-t\fR, \fB-u\fR or \fB--local-stubs\fR is given,
  15 .B widl
  16 will only generate the requested files, and no others.  When run with
  17 \fB--dlldata-only\fR, widl will only generate a dlldata file, and it will
  18 contain a list of the names passed as arguments.  Usually the way this file
  19 is updated is that each time
  20 .B widl
  21 is run, it reads any existing dlldata file, and if necessary regenerates it
  22 with the same list of names, but with the present proxy file included.
  23 .PP
  24 When run without any arguments,
  25 .B widl
  26 will print a help message.
  27 .PP
  28 .SH OPTIONS
  29 .PP
  30 .B General options:
  31 .IP "\fB-V\fR"
  32 Print version number and exit.
  33 .IP "\fB-o, --output=\fIname"
  34 Set the name of the output file. When generating multiple output
  35 files, this sets only the base name of the file; the respective output
  36 files are then named \fIname\fR.h, \fIname\fR_p.c, etc.
  37 .IP "\fB-b \fIcpu-manufacturer\fR[\fB-\fIkernel\fR]\fB-\fIos\fR"
  38 Set the target architecture when cross-compiling. The target
  39 specification is in the standard autoconf format as returned by
  40 \fBconfig.sub\fR.
  41 .PP
  42 .B Header options:
  43 .IP "\fB-h\fR"
  44 Generate header files. The default output filename is \fIinfile\fB.h\fR.
  45 .IP "\fB--oldnames\fR"
  46 Use old naming conventions.
  47 .PP
  48 .B Type library options:
  49 .IP \fB-t\fR
  50 Generate a type library. The default output filename is
  51 \fIinfile\fB.tlb\fR.  If the output file name ends in \fB.res\fR, a
  52 binary resource file containing the type library is generated instead.
  53 .IP "\fB-m32, -m64\fR"
  54 Generate a Win32 or Win64 type library respectively.
  55 .PP
  56 .B UUID file options:
  57 .IP "\fB-u\fR"
  58 Generate a UUID file. The default output filename is \fIinfile\fB_i.c\fR.
  59 .PP
  60 .B Proxy/stub generation options:
  61 .IP "\fB-c\fR"
  62 Generate a client stub file. The default output filename is \fIinfile\fB_c.c\fR.
  63 .IP "\fB-Os\fR"
  64 Generate inline stubs.
  65 .IP "\fB-Oi\fR"
  66 Generate old-style interpreted stubs.
  67 .IP "\fB-Oif, -Oic, -Oicf\fR"
  68 Generate new-style fully interpreted stubs.
  69 .IP "\fB-p\fR"
  70 Generate a proxy. The default output filename is \fIinfile\fB_p.c\fR.
  71 .IP "\fB--prefix-all=\fIprefix\fR"
  72 Prefix to put on the name of both client and server stubs.
  73 .IP "\fB--prefix-client=\fIprefix\fR"
  74 Prefix to put on the name of client stubs.
  75 .IP "\fB--prefix-server=\fIprefix\fR"
  76 Prefix to put on the name of server stubs.
  77 .IP "\fB-s\fR"
  78 Generate a server stub file. The default output filename is
  79 \fIinfile\fB_s.c\fR.
  80 .IP "\fB--win32\fR, \fB--win64\fR"
  81 Only generate 32-bit or 64-bit code respectively (the default is to
  82 generate both 32-bit and 64-bit versions into the same destination
  83 file).
  84 .PP
  85 .IP "\fB--rt\fR"
  86 Enable additional language extensions for IDL to support WinRT.
  87 .PP
  88 .B Registration script options:
  89 .IP "\fB-r\fR"
  90 Generate a registration script. The default output filename is
  91 \fIinfile\fB_r.rgs\fR. If the output file name ends in \fB.res\fR, a
  92 binary resource file containing the script is generated instead.
  93 .PP
  94 .B Dlldata file options:
  95 .IP "\fB--dlldata-only\fI name1 \fR[\fIname2\fR...]"
  96 Regenerate the dlldata file from scratch using the specified proxy
  97 names. The default output filename is \fBdlldata.c\fR.
  98 .PP
  99 .B Preprocessor options:
 100 .IP "\fB-I \fIpath\fR"
 101 Add a header search directory to path. Multiple search
 102 directories are allowed.
 103 .IP "\fB-D \fIid\fR[\fB=\fIval\fR]"
 104 Define preprocessor macro \fIid\fR with value \fIval\fR.
 105 .IP "\fB-E\fR"
 106 Preprocess only.
 107 .IP "\fB-N\fR"
 108 Do not preprocess input.
 109 .PP
 110 .B Debug options:
 111 .IP "\fB-W\fR"
 112 Enable pedantic warnings.
 113 .IP "\fB-d \fIn\fR"
 114 Set debug level to the non negative integer \fIn\fR.  If
 115 prefixed with \fB0x\fR, it will be interpreted as an hexadecimal
 116 number.  For the meaning of values, see the \fBDEBUG\fR section.
 117 .PP
 118 .B Miscellaneous options:
 119 .IP "\fB-app_config\fR"
 120 Ignored, present for midl compatibility.
 121 .IP "\fB--local-stubs=\fIfile\fR"
 122 Generate empty stubs for call_as/local methods in an object interface and
 123 write them to \fIfile\fR.
 124 .PP
 125 .SH DEBUG
 126 Debug level \fIn\fR is a bitmask with the following meaning:
 127     * 0x01 Tell which resource is parsed (verbose mode)
 128     * 0x02 Dump internal structures
 129     * 0x04 Create a parser trace (yydebug=1)
 130     * 0x08 Preprocessor messages
 131     * 0x10 Preprocessor lex messages
 132     * 0x20 Preprocessor yacc trace
 133 .SH BUGS
 134 Bugs can be reported on the
 135 .UR http://bugs.winehq.org
 136 .B Wine bug tracker
 137 .UE .
 138 .SH AUTHORS
 139 .B widl
 140 was originally written by Ove Kåven.  It has been improved by Rob Shearman,
 141 Dan Hipschman, and others.  For a complete list, see the git commit logs.
 142 This man page was originally written by Hannu Valtonen and then updated by
 143 Dan Hipschman.
 144 .SH AVAILABILITY
 145 .B widl
 146 is part of the Wine distribution, which is available through WineHQ,
 147 the
 148 .UR http://www.winehq.org/
 149 .B Wine development headquarters
 150 .UE .
 151 .SH "SEE ALSO"
 152 .UR http://www.winehq.org/help
 153 .B Wine documentation and support
 154 .UE .