widl: Update the manpage.
This commit is contained in:
parent
ff8930f2bf
commit
fd6a276f4c
|
@ -1,29 +1,43 @@
|
||||||
.\" -*- nroff -*-
|
.\" -*- nroff -*-
|
||||||
.TH WIDL 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
|
.TH WIDL 1 "October 2007" "@PACKAGE_STRING@" "Wine Developers Manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
widl \- Wine Interface Definition Language Compiler
|
widl \- Wine Interface Definition Language (IDL) compiler
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.BR "widl "\fI[options]\fR " \fIinfile.idl\fR"
|
|
||||||
.SH DESCRIPTION
|
|
||||||
.B widl
|
.B widl
|
||||||
is a Wine tool which purpose is to compile Interface Definition Language (IDL) files.
|
[\fIoptions\fR] \fIinfile\fR.idl
|
||||||
|
.br
|
||||||
|
.B widl
|
||||||
|
[\fIoptions\fR] \fB--dlldata-only\fR \fIname1\fR [\fIname2\fR ...]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
When no options are used the program will generate a header file, and possibly
|
||||||
|
client and server stubs, proxy and dlldata files, a typelib, and a UUID file,
|
||||||
|
depending on the contents of the IDL file. If any of the options \fB-c\fR,
|
||||||
|
\fB-h\fR, \fB-p\fR, \fB-s\fR, \fB-t\fR, or \fB-u\fR are given,
|
||||||
|
.B widl
|
||||||
|
will only generate the requested files, and no others. When run with
|
||||||
|
\fB--dlldata-only\fR, widl will only generate a dlldata file, and it will
|
||||||
|
contain a list of the names passed as arguments. Usually the way this file
|
||||||
|
is updated is that each time
|
||||||
|
.B widl
|
||||||
|
is run, it reads any existing dlldata file, and if necessary regenerates it
|
||||||
|
with the same list of names, but with the present proxy file included.
|
||||||
|
.PP
|
||||||
|
When run without any arguments,
|
||||||
|
.B widl
|
||||||
|
will print a help message.
|
||||||
.PP
|
.PP
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.B Help mode:
|
|
||||||
.nf
|
|
||||||
No options are used.
|
|
||||||
The program prints the help info and then exits.
|
|
||||||
.PP
|
.PP
|
||||||
.B General options:
|
.B General options:
|
||||||
.IP "\fB-V\fR"
|
.IP "\fB-V\fR"
|
||||||
Print version number and exits from the program.
|
Print version number and exit.
|
||||||
.PP
|
.PP
|
||||||
.B Header options:
|
.B Header options:
|
||||||
.IP "\fB-h\fR"
|
.IP "\fB-h\fR"
|
||||||
Generate header files.
|
Generate header files.
|
||||||
.IP "\fB-H \fIfile\fR"
|
.IP "\fB-H \fIfile\fR"
|
||||||
Name of header file to generate. The default header
|
Name of header file to generate. The default header
|
||||||
filename is infile.h.
|
filename is \fIinfile\fR.h.
|
||||||
.IP "\fB--oldnames\fR"
|
.IP "\fB--oldnames\fR"
|
||||||
Use old naming conventions.
|
Use old naming conventions.
|
||||||
.PP
|
.PP
|
||||||
|
@ -32,35 +46,45 @@ Use old naming conventions.
|
||||||
Generate a type library.
|
Generate a type library.
|
||||||
.IP "\fB-T \fIfile\fR"
|
.IP "\fB-T \fIfile\fR"
|
||||||
Define the name of the type library to be generated.
|
Define the name of the type library to be generated.
|
||||||
The default filename is infile.tlb.
|
The default filename is \fIinfile\fR.tlb.
|
||||||
.PP
|
.PP
|
||||||
.B UUID file options:
|
.B UUID file options:
|
||||||
.IP "\fB-u\fR"
|
.IP "\fB-u\fR"
|
||||||
Generate a UUID file.
|
Generate a UUID file.
|
||||||
.IP "\fB-U \fIfile\fR"
|
.IP "\fB-U \fIfile\fR"
|
||||||
Define the name of the UUID file to be generated.
|
Define the name of the UUID file to be generated.
|
||||||
The default filename is infile_i.c.
|
The default filename is \fIinfile\fR_i.c.
|
||||||
.PP
|
.PP
|
||||||
.B Proxy/stub generation options:
|
.B Proxy/stub generation options:
|
||||||
.IP "\fB-c\fR"
|
.IP "\fB-c\fR"
|
||||||
Generate client stub.
|
Generate client stub.
|
||||||
.IP "\fB-C \fIfile\fR"
|
.IP "\fB-C \fIfile\fR"
|
||||||
Name of client stub file (default is infile_c.c)
|
Name of client stub file (default is \fIinfile\fR_c.c)
|
||||||
.IP "\fB-p\fR"
|
.IP "\fB-p\fR"
|
||||||
Generate proxy.
|
Generate proxy.
|
||||||
.IP "\fB-P \fIfile\fR"
|
.IP "\fB-P \fIfile\fR"
|
||||||
Name of proxy file (default is infile_p.c)
|
Name of proxy file (default is \fIinfile\fR_p.c)
|
||||||
|
.IP "\fB--prefix-all=\fIprefix\fR"
|
||||||
|
Prefix to put on the name of both client and server stubs.
|
||||||
|
.IP "\fB--prefix-client=\fIprefix\fR"
|
||||||
|
Prefix to put on the name of client stubs.
|
||||||
|
.IP "\fB--prefix-server=\fIprefix\fR"
|
||||||
|
Prefix to put on the name of server stubs.
|
||||||
.IP "\fB-s\fR"
|
.IP "\fB-s\fR"
|
||||||
Generate server stub.
|
Generate server stub.
|
||||||
.IP "\fB-S \fIfile\fR"
|
.IP "\fB-S \fIfile\fR"
|
||||||
Name of server stub file (default is infile_s.c)
|
Name of server stub file (default is \fIinfile\fR_s.c)
|
||||||
|
.PP
|
||||||
|
.B Dlldata file options:
|
||||||
|
.IP "\fB--dlldata=\fIfile\fR"
|
||||||
|
Name of the dlldata file (default is dlldata.c)
|
||||||
.PP
|
.PP
|
||||||
.B Preprocessor options:
|
.B Preprocessor options:
|
||||||
.IP "\fB-I \fIpath\fR"
|
.IP "\fB-I \fIpath\fR"
|
||||||
Add a header search dir to path. Multiple search
|
Add a header search directory to path. Multiple search
|
||||||
dirs are allowed.
|
directories are allowed.
|
||||||
.IP "\fB-D \fIid[=val]\fR"
|
.IP "\fB-D \fIid\fR[=\fIval\fR]"
|
||||||
Define preprocessor identifier id value.
|
Define preprocessor macro \fIid\fR with value \fIval\fR.
|
||||||
.IP "\fB-E\fR"
|
.IP "\fB-E\fR"
|
||||||
Preprocess only.
|
Preprocess only.
|
||||||
.IP "\fB-N\fR"
|
.IP "\fB-N\fR"
|
||||||
|
@ -70,13 +94,12 @@ Do not preprocess input.
|
||||||
.IP "\fB-W\fR"
|
.IP "\fB-W\fR"
|
||||||
Enable pedantic warnings.
|
Enable pedantic warnings.
|
||||||
.IP "\fB-d \fIn\fR"
|
.IP "\fB-d \fIn\fR"
|
||||||
.nf
|
Set debug level to the nonnegative integer \fIn\fR. If
|
||||||
Set debug level to n.
|
prefixed with \fB0x\fR, it will be interpretted as a hexidecimal
|
||||||
n may be '0x01', '0x02', '0x04', '0x08', '0x10' or '0x20'.
|
number. For the meaning of values, see the \fBDebug\fR section.
|
||||||
(See section \fBDebug\fR)
|
|
||||||
.PP
|
.PP
|
||||||
.SH Debug
|
.SH Debug
|
||||||
Debug level 'n' is a bitmask with the following meaning:
|
Debug level \fIn\fR is a bitmask with the following meaning:
|
||||||
* 0x01 Tell which resource is parsed (verbose mode)
|
* 0x01 Tell which resource is parsed (verbose mode)
|
||||||
* 0x02 Dump internal structures
|
* 0x02 Dump internal structures
|
||||||
* 0x04 Create a parser trace (yydebug=1)
|
* 0x04 Create a parser trace (yydebug=1)
|
||||||
|
@ -84,11 +107,15 @@ Debug level 'n' is a bitmask with the following meaning:
|
||||||
* 0x10 Preprocessor lex messages
|
* 0x10 Preprocessor lex messages
|
||||||
* 0x20 Preprocessor yacc trace
|
* 0x20 Preprocessor yacc trace
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
Typelib generation doesn't work at the moment. It is still under development.
|
.B widl
|
||||||
|
is incomplete. Please file bug reports for this application at
|
||||||
|
.I http://bugs.winehq.org.
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
.B widl
|
.B widl
|
||||||
was written by Ove Kaaven. This man page was written by Hannu
|
was originally written by Ove Kaaven. It has been improved by Rob Shearman,
|
||||||
Valtonen.
|
Dan Hipschman, and others. For a complete list, see the git commit logs.
|
||||||
|
This man page was originally written by Hannu Valtonen and then updated by
|
||||||
|
Dan Hipschman.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
The Winelib User Guide
|
The Winelib User Guide
|
||||||
.nf
|
.nf
|
||||||
|
|
Loading…
Reference in New Issue