summaryrefslogtreecommitdiff
path: root/doc/vapigen.1
blob: 5f4655ecd2680d2e1d6a91cc9294ef155ccf8b3c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH VAPIGEN "1" "April 2023" "Vala API Generator 0.57.0" "User Commands"
.SH NAME
vapigen \- generate a Vala API
.SH SYNOPSIS
.B vapigen \fISOURCE\fP \fIPKGBASE\fP
[\fIOPTION\fR]... [\fIFILE\fR]...
.SH DESCRIPTION
.B vapigen
is a utility which generates Vala API (VAPI) files from GI files,
which may be generated using the vala-gen-introspect(1) utility.
.SS "Usage:"
.IP
vapigen [OPTION?] FILE... \- Vala API Generator
.SS "Help Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help options
.SS "Application Options:"
.TP
\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
Look for package bindings in DIRECTORY
.TP
\fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
Look for GIR bindings in DIRECTORY
.TP
\fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
Look for GIR .metadata files in DIRECTORY
.TP
\fB\-\-nostdpkg\fR
Do not include standard packages
.TP
\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
Include binding for PACKAGE
.TP
\fB\-\-library\fR=\fI\,NAME\/\fR
Library name
.TP
\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
Output directory
.TP
\fB\-\-disable\-warnings\fR
Disable warnings
.TP
\fB\-\-version\fR
Display version number
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Do not print messages to the console
.SH BUGS
https://gitlab.gnome.org/GNOME/vala/issues
.SH "HOMEPAGE OR CONTACT"
https://wiki.gnome.org/Projects/Vala
.SH AUTHORS
J??rg Billeter, Raffaele Sandrini.
.SH EXAMPLES
After compilation, the following command generates a GI for pango:
.B vala-gen-introspect pango packages/pango
.TP
This can then be converted to a Vala API as follows:
.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
.SH "SEE ALSO"
vala-gen-introspect (1)