widl(1) - f14

1WIDL(1)                     Wine Developers Manual                     WIDL(1)
2
3
4

NAME

6       widl - Wine Interface Definition Language (IDL) compiler
7

SYNOPSIS

9       widl [options] infile.idl
10       widl [options] --dlldata-only name1 [name2 ...]
11

DESCRIPTION

13       When  no  options are used the program will generate a header file, and
14       possibly client and server stubs, proxy and dlldata files,  a  typelib,
15       and  a UUID file, depending on the contents of the IDL file.  If any of
16       the options -c, -h, -p, -s, -t, -u, or --local-stubs  are  given,  widl
17       will  only  generate the requested files, and no others.  When run with
18       --dlldata-only, widl will only generate a dlldata  file,  and  it  will
19       contain  a list of the names passed as arguments.  Usually the way this
20       file is updated is that each time widl is run, it  reads  any  existing
21       dlldata  file,  and  if  necessary regenerates it with the same list of
22       names, but with the present proxy file included.
23
24       When run without any arguments, widl will print a help message.
25

OPTIONS

27       General options:
28
29       -V     Print version number and exit.
30
31       -o, --output=name
32              Set the name of the output file. When generating multiple output
33              files,  this sets only the base name of the file; the respective
34              output files are then named name.h, name_p.c, etc.
35
36       -b cpu-manufacturer[-kernel]-os
37              Set the target architecture  when  cross-compiling.  The  target
38              specification  is in the standard autoconf format as returned by
39              config.sub.
40
41       Header options:
42
43       -h     Generate header files. The default output filename is infile.h.
44
45       --oldnames
46              Use old naming conventions.
47
48       Type library options:
49
50       -t     Generate  a  type  library.  The  default  output  filename   is
51              infile.tlb.
52
53       -m32, -m64
54              Generate a Win32, respectively Win64, type library.
55
56       UUID file options:
57
58       -u     Generate a UUID file. The default output filename is infile_i.c.
59
60       Proxy/stub generation options:
61
62       -c     Generate  a  client  stub  file.  The default output filename is
63              infile_c.c.
64
65       -Os    Generate inline stubs.
66
67       -Oi    Generate old-style interpreted stubs.
68
69       -Oif, -Oic, -Oicf
70              Generate new-style fully interpreted stubs.
71
72       -p     Generate a proxy. The default output filename is infile_p.c.
73
74       --prefix-all=prefix
75              Prefix to put on the name of both client and server stubs.
76
77       --prefix-client=prefix
78              Prefix to put on the name of client stubs.
79
80       --prefix-server=prefix
81              Prefix to put on the name of server stubs.
82
83       -s     Generate a server stub file.  The  default  output  filename  is
84              infile_s.c.
85
86       --win32, --win64
87              Only  generate  32-bit, respectively 64-bit code (the default is
88              to generate both 32-bit and 64-bit versions into the same desti‐
89              nation file).
90
91       Registration script options:
92
93       -r     Generate  a  registration script. The default output filename is
94              infile_r.rgs. If the output file name ends  in  .res,  a  binary
95              resource file containing the script is generated instead.
96
97       Dlldata file options:
98
99       --dlldata-only name1 [name2...]
100              Regenerate  the  dlldata  file  from scratch using the specified
101              proxy names. The default output filename is dlldata.c.
102
103       Preprocessor options:
104
105       -I path
106              Add a header search directory to path. Multiple search  directo‐
107              ries are allowed.
108
109       -D id[=val]
110              Define preprocessor macro id with value val.
111
112       -E     Preprocess only.
113
114       -N     Do not preprocess input.
115
116       Debug options:
117
118       -W     Enable pedantic warnings.
119
120       -d n   Set debug level to the non negative integer n.  If prefixed with
121              0x, it will be interpreted as an hexadecimal  number.   For  the
122              meaning of values, see the Debug section.
123
124       Miscellaneous options:
125
126       --local-stubs=file
127              Generate  empty  stubs  for  call_as/local  methods in an object
128              interface and write them to file.
129

Debug

131       Debug level n is a bitmask with the following meaning:
132           * 0x01 Tell which resource is parsed (verbose mode)
133           * 0x02 Dump internal structures
134           * 0x04 Create a parser trace (yydebug=1)
135           * 0x08 Preprocessor messages
136           * 0x10 Preprocessor lex messages
137           * 0x20 Preprocessor yacc trace
138

BUGS

140       widl is incomplete.  Please file bug reports for  this  application  at
141       http://bugs.winehq.org.
142

AUTHORS

144       widl was originally written by Ove Kaaven.  It has been improved by Rob
145       Shearman, Dan Hipschman, and others.  For a complete list, see the  git
146       commit  logs.   This  man page was originally written by Hannu Valtonen
147       and then updated by Dan Hipschman.
148