tools/widl/widl.man.in

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