Add --gir option to enable GIR generation
[vala-lang.git] / doc / vapigen.1
blob325c53e605187abe73ee8511b3732eeaa24878e7
1 .TH vapigen 1 "26 October 2007" "vala-0.1.5" "Vala"
2 .IX vapigen
3 .SH NAME
4 vapigen \- generate a Vala API
5 .SH SYNOPSIS
6 .B vapigen \fISOURCE\fP \fIPKGBASE\fP
7 [\fIOPTION\fR]... [\fIFILE\fR]...
8 .SH DESCRIPTION
9 .B vapigen
10 is a utility which generates Vala API (VAPI) files from GI files,
11 which may be generated using the vala-gen-introspect(1) utility.
13 .SH EXAMPLES
14 .TP
15 After compilation, the following command generates a GI for pango:
16 .B vala-gen-introspect pango packages/pango
17 .TP
18 This can then be converted to a Vala API as follows:
19 .B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
21 .SH OPTIONS
22 .TP
23 \-?, \-\-help
24 Show help option
25 .TP
26 --vapidir=\fIDIRECTORY\fP
27 Look for package bindings in \fIDIRECTORY\fP.
28 .TP
29 --pkg=\fIPACKAGE\fP
30 Include binding for PACKAGE
31 .TP
32 --library=\fINAME\fP
33 Specify library name as \fINAME\fP
34 .TP
35 \-d, \-\-directory=\fIDIRECTORY\fP
36 Specify output directory as \fIDIRECTORY\fP
37 .TP
38 \-\-version
39 Display version number and exit.
41 .SH SEE ALSO
42 .BR vala-gen-introspect (1)
44 .SH AUTHOR
45 vapigen for Vala was written by Juerg Billeter <j@bitron.ch> and
46 Raffaele Sandrini <rasa@gmx.ch>.
47 .PP
48 This manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>,
49 for the Debian project (but may be used by others).