merge ROS Shell without integrated explorer part into trunk
[reactos.git] / reactos / 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-V\fR
18 Print version number and exits from the program.
19 .PP
20 .B Header options:
21 .IP \fB-h\fR
22 Generate header files.
23 .IP "\fB-H \fIfile\fR"
24 Name of header file to generate. The default header
25 filename is infile.h.
26 .PP
27 .B Type library options:
28 .IP \fB-t\fR
29 Generate a type library.
30 .IP "\fB-T \fIfile\fR"
31 Define the name of the type library to be generated.
32 The default filename is infile.tlb.
33 .PP
34 .B Proxy/stub generation options:
35 .IP \fB-c\fR
36 Generate client stub.
37 .IP \fB-C \fIfile\fR
38 Name of client stub file (default is infile_c.c)
39 .IP \fB-c\fR
40 Generate proxy.
41 .IP \fB-P \fIfile\fR
42 Name of proxy file (default is infile_p.c)
43 .IP \fB-s\fR
44 Generate server stub.
45 .IP \fB-S \fIfile\fR
46 Name of server stub file (default is infile_s.c)
47 .PP
48 .B Preprocessor options:
49 .IP "\fB-I \fIpath\fR"
50 Add a header search dir to path. Multiple search
51 dirs are allowed.
52 .IP "\fB-D \fIid[=val]\fR"
53 Define preprocessor identifier id value.
54 .IP \fB-E\fR
55 Preprocess only.
56 .IP \fB-N\fR
57 Do not preprocess input.
58 .PP
59 .B Debug options:
60 .IP \fB-W\fR
61 Enable pedantic warnings.
62 .IP "\fB-d \fIn\fR"
63 .nf
64 Set debug level to n.
65 n may be '0x01', '0x02', '0x04', '0x08', '0x10' or '0x20'.
66 (See section \fBDebug\fR)
67 .PP
68 .SH Debug
69 Debug level 'n' is a bitmask with the following meaning:
70 * 0x01 Tell which resource is parsed (verbose mode)
71 * 0x02 Dump internal structures
72 * 0x04 Create a parser trace (yydebug=1)
73 * 0x08 Preprocessor messages
74 * 0x10 Preprocessor lex messages
75 * 0x20 Preprocessor yacc trace
76 .SH BUGS
77 Typelib generation doesn't work at the moment. It is still under development.
78 .SH AUTHORS
79 .B widl
80 was written by Ove Kaaven. This man page was written by Hannu
81 Valtonen.
82 .SH "SEE ALSO"
83 The Winelib User Guide
84 .nf
85 The Wine Developers Guide