| blob | 9259afdfef8653c78503b97f13a37738b78f15ef |
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 \fIcpu-manufacturer\fR[\fB-\fIkernel\fR]\fB-\fIos\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 .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
52 \fIinfile\fB.tlb\fR. If the output file name ends in \fB.res\fR, a
53 binary resource file containing the type library is generated instead.
54 .IP "\fB-m32, -m64\fR"
55 Generate a Win32 or Win64 type library respectively.
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 .IP "\fB--win32\fR, \fB--win64\fR"
82 Only generate 32-bit or 64-bit code respectively (the default is to
83 generate both 32-bit and 64-bit versions into the same destination
84 file).
85 .PP
86 .IP "\fB--winrt\fR"
87 Enable Windows Runtime mode.
88 .IP "\fB--ns_prefix\fR"
89 Prefix namespaces with ABI namespace.
90 .PP
91 .B Registration script options:
92 .IP "\fB-r\fR"
93 Generate a registration script. The default output filename is
94 \fIinfile\fB_r.rgs\fR. If the output file name ends in \fB.res\fR, a
95 binary resource file containing the script is generated instead.
96 .PP
97 .B Dlldata file options:
98 .IP "\fB--dlldata-only\fI name1 \fR[\fIname2\fR...]"
99 Regenerate the dlldata file from scratch using the specified proxy
100 names. The default output filename is \fBdlldata.c\fR.
101 .PP
102 .B Preprocessor options:
103 .IP "\fB-I \fIpath\fR"
104 Add a header search directory to path. Multiple search
105 directories are allowed.
106 .IP "\fB-D \fIid\fR[\fB=\fIval\fR]"
107 Define preprocessor macro \fIid\fR with value \fIval\fR.
108 .IP "\fB-E\fR"
109 Preprocess only.
110 .IP "\fB-N\fR"
111 Do not preprocess input.
112 .PP
113 .B Debug options:
114 .IP "\fB-W\fR"
115 Enable pedantic warnings.
116 .IP "\fB-d \fIn\fR"
117 Set debug level to the non negative integer \fIn\fR. If
118 prefixed with \fB0x\fR, it will be interpreted as an hexadecimal
119 number. For the meaning of values, see the \fBDEBUG\fR section.
120 .PP
121 .B Miscellaneous options:
122 .IP "\fB-app_config\fR"
123 Ignored, present for midl compatibility.
124 .IP "\fB--local-stubs=\fIfile\fR"
125 Generate empty stubs for call_as/local methods in an object interface and
126 write them to \fIfile\fR.
127 .PP
128 .SH DEBUG
129 Debug level \fIn\fR is a bitmask with the following meaning:
130 * 0x01 Tell which resource is parsed (verbose mode)
131 * 0x02 Dump internal structures
132 * 0x04 Create a parser trace (yydebug=1)
133 * 0x08 Preprocessor messages
134 * 0x10 Preprocessor lex messages
135 * 0x20 Preprocessor yacc trace
136 .SH BUGS
137 Bugs can be reported on the
138 .UR http://bugs.winehq.org
139 .B Wine bug tracker
140 .UE .
141 .SH AUTHORS
142 .B widl
143 was originally written by Ove Kåven. It has been improved by Rob Shearman,
144 Dan Hipschman, and others. For a complete list, see the git commit logs.
145 This man page was originally written by Hannu Valtonen and then updated by
146 Dan Hipschman.
147 .SH AVAILABILITY
148 .B widl
149 is part of the Wine distribution, which is available through WineHQ,
150 the
151 .UR http://www.winehq.org/
152 .B Wine development headquarters
153 .UE .
154 .SH "SEE ALSO"
155 .UR http://www.winehq.org/help
156 .B Wine documentation and support
157 .UE .