| blob | ec81488a0e8d04aefba065a9876dadbd6373a6ee |
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. If a full
37 file name with extension is specified, only that file is generated.
38 .IP "\fB-b, --target=\fIcpu-manufacturer\fR[\fI-kernel\fR]\fI-os\fR"
39 Set the target architecture when cross-compiling. The target
40 specification is in the standard autoconf format as returned by
41 \fBconfig.sub\fR.
42 .IP "\fB-m32, -m64, --win32, --win64\fR"
43 Force the target architecture to 32-bit or 64-bit.
44 .PP
45 .B Header options:
46 .IP "\fB-h\fR"
47 Generate header files. The default output filename is \fIinfile\fB.h\fR.
48 .IP "\fB--oldnames\fR"
49 Use old naming conventions.
50 .PP
51 .B Type library options:
52 .IP \fB-t\fR
53 Generate a type library. The default output filename is
54 \fIinfile\fB.tlb\fR. If the output file name ends in \fB.res\fR, a
55 binary resource file containing the type library is generated instead.
56 .PP
57 .B UUID file options:
58 .IP "\fB-u\fR"
59 Generate a UUID file. The default output filename is \fIinfile\fB_i.c\fR.
60 .PP
61 .B Proxy/stub generation options:
62 .IP "\fB-c\fR"
63 Generate a client stub file. The default output filename is \fIinfile\fB_c.c\fR.
64 .IP "\fB-Os\fR"
65 Generate inline stubs.
66 .IP "\fB-Oi\fR"
67 Generate old-style interpreted stubs.
68 .IP "\fB-Oif, -Oic, -Oicf\fR"
69 Generate new-style fully interpreted stubs.
70 .IP "\fB-p\fR"
71 Generate a proxy. The default output filename is \fIinfile\fB_p.c\fR.
72 .IP "\fB--prefix-all=\fIprefix\fR"
73 Prefix to put on the name of both client and server stubs.
74 .IP "\fB--prefix-client=\fIprefix\fR"
75 Prefix to put on the name of client stubs.
76 .IP "\fB--prefix-server=\fIprefix\fR"
77 Prefix to put on the name of server stubs.
78 .IP "\fB-s\fR"
79 Generate a server stub file. The default output filename is
80 \fIinfile\fB_s.c\fR.
81 .PP
82 .IP "\fB--winrt\fR"
83 Enable Windows Runtime mode.
84 .IP "\fB--ns_prefix\fR"
85 Prefix namespaces with ABI namespace.
86 .PP
87 .B Registration script options:
88 .IP "\fB-r\fR"
89 Generate a registration script. The default output filename is
90 \fIinfile\fB_r.rgs\fR. If the output file name ends in \fB.res\fR, a
91 binary resource file containing the script is generated instead.
92 .PP
93 .B Dlldata file options:
94 .IP "\fB--dlldata-only\fI name1 \fR[\fIname2\fR...]"
95 Regenerate the dlldata file from scratch using the specified proxy
96 names. The default output filename is \fBdlldata.c\fR.
97 .PP
98 .B Preprocessor options:
99 .IP "\fB-I \fIpath\fR"
100 Add a header search directory to path. Multiple search
101 directories are allowed.
102 .IP "\fB-D \fIid\fR[\fB=\fIval\fR]"
103 Define preprocessor macro \fIid\fR with value \fIval\fR.
104 .IP "\fB-E\fR"
105 Preprocess only.
106 .IP "\fB-N\fR"
107 Do not preprocess input.
108 .PP
109 .B Debug options:
110 .IP "\fB-W\fR"
111 Enable pedantic warnings.
112 .IP "\fB-d \fIn\fR"
113 Set debug level to the non negative integer \fIn\fR. If
114 prefixed with \fB0x\fR, it will be interpreted as an hexadecimal
115 number. For the meaning of values, see the \fBDEBUG\fR section.
116 .PP
117 .B Miscellaneous options:
118 .IP "\fB-app_config\fR"
119 Ignored, present for midl compatibility.
120 .IP "\fB--acf=\fIfile\fR"
121 Use specified application configuration file.
122 .IP "\fB--local-stubs=\fIfile\fR"
123 Generate empty stubs for call_as/local methods in an object interface and
124 write them to \fIfile\fR.
125 .PP
126 .SH DEBUG
127 Debug level \fIn\fR is a bitmask with the following meaning:
128 * 0x01 Tell which resource is parsed (verbose mode)
129 * 0x02 Dump internal structures
130 * 0x04 Create a parser trace (yydebug=1)
131 * 0x08 Preprocessor messages
132 * 0x10 Preprocessor lex messages
133 * 0x20 Preprocessor yacc trace
134 .SH BUGS
135 Bugs can be reported on the
136 .UR https://bugs.winehq.org
137 .B Wine bug tracker
138 .UE .
139 .SH AUTHORS
140 .B widl
141 was originally written by Ove Kåven. It has been improved by Rob Shearman,
142 Dan Hipschman, and others. For a complete list, see the git commit logs.
143 This man page was originally written by Hannu Valtonen and then updated by
144 Dan Hipschman.
145 .SH AVAILABILITY
146 .B widl
147 is part of the Wine distribution, which is available through WineHQ,
148 the
149 .UR https://www.winehq.org/
150 .B Wine development headquarters
151 .UE .
152 .SH "SEE ALSO"
153 .UR https://www.winehq.org/help
154 .B Wine documentation and support
155 .UE .