Store interfaces, structs, coclasses and modules that are to be
[wine] / tools / widl / widl.man
1 .TH WIDL 1 "March 2004" "Wine Manpage" "Wine Developers Manual"
2 .SH NAME
3 widl \- Wine Interface Definition Language Compiler
4 .SH SYNOPSIS
5 .BR "widl "\fI[options]\fR " \fIinfile.idl\fR"
6 .SH DESCRIPTION
7 .B widl 
8 is a Wine tool which purpose is to compile Interface Definition Language (IDL) files.
9 .PP
10 .SH OPTIONS
11 .B Help mode:
12 .nf
13 No options are used.
14 The program prints the help info and then exits.
15 .PP
16 .B General options:
17 .IP \fB-t\fR
18 Only generate a type library.
19 .IP "\fB-T \fIfile\fR"
20 Define the name of the type library to be generated. 
21 The default filename is infile.tlb.
22 .IP \fB-V\fR
23 Print version number and exits from the program.
24 .PP
25 .B Header options:
26 .IP \fB-h\fR
27 Only generate header files.
28 .IP "\fB-H \fIfile\fR"
29 Name of header file to generate. The default header
30 filename is infile.h.
31 .PP
32 .B Preprocessor options:
33 .IP "\fB-I \fIpath\fR"
34 Add a header search dir to path. Multiple search 
35 dirs are allowed.
36 .IP "\fB-D \fIid[=val]\fR"
37 Define preprocessor identifier id value.
38 .IP \fB-E\fR
39 Preprocess only.
40 .IP \fB-N\fR
41 Do not preprocess input.
42 .PP
43 .B Debug options:
44 .IP \fB-W\fR
45 Enable pedantic warnings.
46 .IP "\fB-d \fIn\fR"
47 .nf
48 Set debug level to n. 
49 n may be '0x01', '0x02', '0x04', '0x08', '0x10' or '0x20'.
50 (See section \fBDebug\fR)
51 .PP
52 .SH Debug
53 Debug level 'n' is a bitmask with the following meaning:
54     * 0x01 Tell which resource is parsed (verbose mode)
55     * 0x02 Dump internal structures
56     * 0x04 Create a parser trace (yydebug=1)
57     * 0x08 Preprocessor messages
58     * 0x10 Preprocessor lex messages
59     * 0x20 Preprocessor yacc trace
60 .SH BUGS
61 Typelib generation doesn't work at the moment. It is still under development.
62 .SH AUTHORS
63 .B widl
64 was written by Ove Kaaven. This man page was written by Hannu
65 Valtonen.
66 .SH "SEE ALSO"
67 The Winelib User Guide
68 .nf
69 The Wine Developers Guide