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