summaryrefslogtreecommitdiff
path: root/doc/vala-gen-introspect.1
blob: e517806f430e7ad20c2a571815d7e99ff590885e (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
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH VALA-GEN-INTROSPECT "1" "April 2023" "gen-introspect 0.57.0" "User Commands"
.SH NAME
vala-gen-introspect \- generate a GI file for GObject and glib based packages
.SH SYNOPSIS
.B vala-gen-introspect \fIPKGNAME\fP \fIPKGBASE\fP
.SH DESCRIPTION
.B vala-gen-introspect
is a utility which generates GI files from GObject and glib
based packages. It can be used in combination with vapigen(1) to
generate an API for Vala, and allow its usage in Vala for compiling
to native code. \fIPKGNAME\fP is the pkg-config name of the library
and \fIPKGBASE\fP specifies the base directory for that package.
.SS "Usage:"
.IP
gen\-introspect [OPTION?]
.SS "Help Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help options
.SS "Application Options:"
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
write output here instead of stdout
.TP
\fB\-n\fR, \fB\-\-namespace\fR=\fI\,NAMESPACE\/\fR
Namespace of the module, like 'Gtk'
.TP
\fB\-\-shared\-library\fR=\fI\,FILE\/\fR
Shared library which contains the symbols
.TP
\fB\-\-include\-idl\fR=\fI\,IDL\/\fR
Other gidls to include
.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"
vapigen (1)