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-b \fIcpu-manufacturer[-kernel]-os\fR"
  35 Set the target architecture when cross-compiling. The target
  36 specification is in the standard autoconf format as returned by
  37 config.sub.
  38 .PP
  39 .B Header options:
  40 .IP "\fB-h\fR"
  41 Generate header files.
  42 .IP "\fB-H \fIfile\fR"
  43 Name of header file to generate. The default header
  44 filename is \fIinfile\fR.h.
  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.
  51 .IP "\fB-T \fIfile\fR"
  52 Define the name of the type library to be generated.
  53 The default filename is \fIinfile\fR.tlb.
  54 .IP "\fB-m32, -m64\fR"
  55 Generate a Win32, respectively Win64, type library.
  56 .PP
  57 .B UUID file options:
  58 .IP "\fB-u\fR"
  59 Generate a UUID file.
  60 .IP "\fB-U \fIfile\fR"
  61 Define the name of the UUID file to be generated.
  62 The default filename is \fIinfile\fR_i.c.
  63 .PP
  64 .B Proxy/stub generation options:
  65 .IP "\fB-c\fR"
  66 Generate client stub.
  67 .IP "\fB-C \fIfile\fR"
  68 Name of client stub file (default is \fIinfile\fR_c.c)
  69 .IP "\fB-p\fR"
  70 Generate proxy.
  71 .IP "\fB-P \fIfile\fR"
  72 Name of proxy file (default is \fIinfile\fR_p.c)
  73 .IP "\fB--prefix-all=\fIprefix\fR"
  74 Prefix to put on the name of both client and server stubs.
  75 .IP "\fB--prefix-client=\fIprefix\fR"
  76 Prefix to put on the name of client stubs.
  77 .IP "\fB--prefix-server=\fIprefix\fR"
  78 Prefix to put on the name of server stubs.
  79 .IP "\fB-s\fR"
  80 Generate server stub.
  81 .IP "\fB-S \fIfile\fR"
  82 Name of server stub file (default is \fIinfile\fR_s.c)
  83 .IP "\fB--win32, --win64\fR"
  84 Only generate 32-bit, respectively 64-bit code (the default is to
  85 generate both 32-bit and 64-bit versions into the same destination
  86 file).
  87 .PP
  88 .B Dlldata file options:
  89 .IP "\fB--dlldata=\fIfile\fR"
  90 Name of the dlldata file (default is dlldata.c)
  91 .PP
  92 .B Preprocessor options:
  93 .IP "\fB-I \fIpath\fR"
  94 Add a header search directory to path. Multiple search
  95 directories are allowed.
  96 .IP "\fB-D \fIid\fR[=\fIval\fR]"
  97 Define preprocessor macro \fIid\fR with value \fIval\fR.
  98 .IP "\fB-E\fR"
  99 Preprocess only.
 100 .IP "\fB-N\fR"
 101 Do not preprocess input.
 102 .PP
 103 .B Debug options:
 104 .IP "\fB-W\fR"
 105 Enable pedantic warnings.
 106 .IP "\fB-d \fIn\fR"
 107 Set debug level to the non negative integer \fIn\fR.  If
 108 prefixed with \fB0x\fR, it will be interpreted as an hexadecimal
 109 number.  For the meaning of values, see the \fBDebug\fR section.
 110 .PP
 111 .B Miscellaneous options:
 112 .IP "\fB--local-stubs=\fIfile\fR"
 113 Generate empty stubs for call_as/local methods in an object interface and
 114 write them to \fIfile\fR.
 115 .PP
 116 .SH Debug
 117 Debug level \fIn\fR is a bitmask with the following meaning:
 118     * 0x01 Tell which resource is parsed (verbose mode)
 119     * 0x02 Dump internal structures
 120     * 0x04 Create a parser trace (yydebug=1)
 121     * 0x08 Preprocessor messages
 122     * 0x10 Preprocessor lex messages
 123     * 0x20 Preprocessor yacc trace
 124 .SH BUGS
 125 .B widl
 126 is incomplete.  Please file bug reports for this application at
 127 .I http://bugs.winehq.org.
 128 .SH AUTHORS
 129 .B widl
 130 was originally written by Ove Kaaven.  It has been improved by Rob Shearman,
 131 Dan Hipschman, and others.  For a complete list, see the git commit logs.
 132 This man page was originally written by Hannu Valtonen and then updated by
 133 Dan Hipschman.
 134 .SH "SEE ALSO"
 135 The Winelib User Guide
 136 .nf
 137 The Wine Developers Guide