Release 0.34.18
[vala-gnome.git] / doc / vapigen.1
blob513178ce0831c97a1b1116c2ddf2e6513a357bab
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
2 .TH VAPIGEN "1" "May 2018" "vapigen API Generator 0.34.18" "User Commands"
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.
12 .SS "Usage:"
13 .IP
14 vapigen [OPTION?] FILE... \- Vala API Generator
15 .SS "Help Options:"
16 .TP
17 \fB\-h\fR, \fB\-\-help\fR
18 Show help options
19 .SS "Application Options:"
20 .TP
21 \fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
22 Look for package bindings in DIRECTORY
23 .TP
24 \fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
25 Look for GIR bindings in DIRECTORY
26 .TP
27 \fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
28 Look for GIR .metadata files in DIRECTORY
29 .TP
30 \fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
31 Include binding for PACKAGE
32 .TP
33 \fB\-\-library\fR=\fI\,NAME\/\fR
34 Library name
35 .TP
36 \fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
37 Output directory
38 .TP
39 \fB\-\-disable\-warnings\fR
40 Disable warnings
41 .TP
42 \fB\-\-version\fR
43 Display version number
44 .TP
45 \fB\-q\fR, \fB\-\-quiet\fR
46 Do not print messages to the console
47 .SH BUGS
48 https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
49 .SH "HOMEPAGE OR CONTACT"
50 https://wiki.gnome.org/Projects/Vala
51 .SH AUTHORS
52 J??rg Billeter, Raffaele Sandrini.
53 .SH EXAMPLES
54 After compilation, the following command generates a GI for pango:
55 .B vala-gen-introspect pango packages/pango
56 .TP
57 This can then be converted to a Vala API as follows:
58 .B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
59 .SH "SEE ALSO"
60 vala-gen-introspect (1)