widl: Recurse search for need of delegation.
[wine] / 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 .IP "\fB--win32, --win64\fR"
78 Only generate 32-bit, respectively 64-bit code (the default is to
79 generate both 32-bit and 64-bit versions into the same destination
80 file).
81 .PP
82 .B Dlldata file options:
83 .IP "\fB--dlldata=\fIfile\fR"
84 Name of the dlldata file (default is dlldata.c)
85 .PP
86 .B Preprocessor options:
87 .IP "\fB-I \fIpath\fR"
88 Add a header search directory to path. Multiple search
89 directories are allowed.
90 .IP "\fB-D \fIid\fR[=\fIval\fR]"
91 Define preprocessor macro \fIid\fR with value \fIval\fR.
92 .IP "\fB-E\fR"
93 Preprocess only.
94 .IP "\fB-N\fR"
95 Do not preprocess input.
96 .PP
97 .B Debug options:
98 .IP "\fB-W\fR"
99 Enable pedantic warnings.
100 .IP "\fB-d \fIn\fR"
101 Set debug level to the non negative integer \fIn\fR.  If
102 prefixed with \fB0x\fR, it will be interpreted as an hexadecimal
103 number.  For the meaning of values, see the \fBDebug\fR section.
104 .PP
105 .B Miscellaneous options:
106 .IP "\fB--local-stubs=\fIfile\fR"
107 Generate empty stubs for call_as/local methods in an object interface and
108 write them to \fIfile\fR.
109 .PP
110 .SH Debug
111 Debug level \fIn\fR is a bitmask with the following meaning:
112     * 0x01 Tell which resource is parsed (verbose mode)
113     * 0x02 Dump internal structures
114     * 0x04 Create a parser trace (yydebug=1)
115     * 0x08 Preprocessor messages
116     * 0x10 Preprocessor lex messages
117     * 0x20 Preprocessor yacc trace
118 .SH BUGS
119 .B widl
120 is incomplete.  Please file bug reports for this application at
121 .I http://bugs.winehq.org.
122 .SH AUTHORS
123 .B widl
124 was originally written by Ove Kaaven.  It has been improved by Rob Shearman,
125 Dan Hipschman, and others.  For a complete list, see the git commit logs.
126 This man page was originally written by Hannu Valtonen and then updated by
127 Dan Hipschman.
128 .SH "SEE ALSO"
129 The Winelib User Guide
130 .nf
131 The Wine Developers Guide