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