tools/widl/widl.man.in

   1 .\" -*- nroff -*-
   2 .TH WIDL 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
   3 .SH NAME
   4 widl \- Wine Interface Definition Language Compiler
   5 .SH SYNOPSIS
   6 .BR "widl "\fI[options]\fR " \fIinfile.idl\fR"
   7 .SH DESCRIPTION
   8 .B widl
   9 is a Wine tool which purpose is to compile Interface Definition Language (IDL) files.
  10 .PP
  11 .SH OPTIONS
  12 .B Help mode:
  13 .nf
  14 No options are used.
  15 The program prints the help info and then exits.
  16 .PP
  17 .B General options:
  18 .IP "\fB-V\fR"
  19 Print version number and exits from the program.
  20 .PP
  21 .B Header options:
  22 .IP "\fB-h\fR"
  23 Generate header files.
  24 .IP "\fB-H \fIfile\fR"
  25 Name of header file to generate. The default header
  26 filename is infile.h.
  27 .IP "\fB--oldnames\fR"
  28 Use old naming conventions.
  29 .PP
  30 .B Type library options:
  31 .IP \fB-t\fR
  32 Generate a type library.
  33 .IP "\fB-T \fIfile\fR"
  34 Define the name of the type library to be generated.
  35 The default filename is infile.tlb.
  36 .PP
  37 .B UUID file options:
  38 .IP "\fB-u\fR"
  39 Generate a UUID file.
  40 .IP "\fB-U \fIfile\fR"
  41 Define the name of the UUID file to be generated.
  42 The default filename is infile_i.c.
  43 .PP
  44 .B Proxy/stub generation options:
  45 .IP "\fB-c\fR"
  46 Generate client stub.
  47 .IP "\fB-C \fIfile\fR"
  48 Name of client stub file (default is infile_c.c)
  49 .IP "\fB-p\fR"
  50 Generate proxy.
  51 .IP "\fB-P \fIfile\fR"
  52 Name of proxy file (default is infile_p.c)
  53 .IP "\fB-s\fR"
  54 Generate server stub.
  55 .IP "\fB-S \fIfile\fR"
  56 Name of server stub file (default is infile_s.c)
  57 .PP
  58 .B Preprocessor options:
  59 .IP "\fB-I \fIpath\fR"
  60 Add a header search dir to path. Multiple search
  61 dirs are allowed.
  62 .IP "\fB-D \fIid[=val]\fR"
  63 Define preprocessor identifier id value.
  64 .IP "\fB-E\fR"
  65 Preprocess only.
  66 .IP "\fB-N\fR"
  67 Do not preprocess input.
  68 .PP
  69 .B Debug options:
  70 .IP "\fB-W\fR"
  71 Enable pedantic warnings.
  72 .IP "\fB-d \fIn\fR"
  73 .nf
  74 Set debug level to n.
  75 n may be '0x01', '0x02', '0x04', '0x08', '0x10' or '0x20'.
  76 (See section \fBDebug\fR)
  77 .PP
  78 .SH Debug
  79 Debug level 'n' is a bitmask with the following meaning:
  80     * 0x01 Tell which resource is parsed (verbose mode)
  81     * 0x02 Dump internal structures
  82     * 0x04 Create a parser trace (yydebug=1)
  83     * 0x08 Preprocessor messages
  84     * 0x10 Preprocessor lex messages
  85     * 0x20 Preprocessor yacc trace
  86 .SH BUGS
  87 Typelib generation doesn't work at the moment. It is still under development.
  88 .SH AUTHORS
  89 .B widl
  90 was written by Ove Kaaven. This man page was written by Hannu
  91 Valtonen.
  92 .SH "SEE ALSO"
  93 The Winelib User Guide
  94 .nf
  95 The Wine Developers Guide