Release 0.40.3
[vala-gnome.git] / doc / vala-gen-introspect.1
blobe5c8205961e5a0a454427ebf4bc87bcc8fac1131
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
2 .TH VALA-GEN-INTROSPECT "1" "April 2018" "vala-gen-introspect 0.40.3" "User Commands"
3 .SH NAME
4 vala-gen-introspect \- generate a GI file for GObject and glib based packages
5 .SH SYNOPSIS
6 .B vala-gen-introspect \fIPKGNAME\fP \fIPKGBASE\fP
7 .SH DESCRIPTION
8 .B vala-gen-introspect
9 is a utility which generates GI files from GObject and glib
10 based packages. It can be used in combination with vapigen(1) to
11 generate an API for Vala, and allow it's usage in Vala for compiling
12 to native code. \fIPKGNAME\fP is the pkg-config name of the library
13 and \fIPKGBASE\fP specifies the base directory for that package.
14 .SS "Usage:"
15 .IP
16 gen\-introspect [OPTION?]
17 .SS "Help Options:"
18 .TP
19 \fB\-h\fR, \fB\-\-help\fR
20 Show help options
21 .SS "Application Options:"
22 .TP
23 \fB\-v\fR, \fB\-\-verbose\fR
24 Be verbose
25 .TP
26 \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
27 write output here instead of stdout
28 .TP
29 \fB\-n\fR, \fB\-\-namespace\fR=\fI\,NAMESPACE\/\fR
30 Namespace of the module, like 'Gtk'
31 .TP
32 \fB\-\-shared\-library\fR=\fI\,FILE\/\fR
33 Shared library which contains the symbols
34 .TP
35 \fB\-\-include\-idl\fR=\fI\,IDL\/\fR
36 Other gidls to include
37 .SH BUGS
38 https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
39 .SH "HOMEPAGE OR CONTACT"
40 https://wiki.gnome.org/Projects/Vala
41 .SH AUTHORS
42 J??rg Billeter <j@bitron.ch>, Raffaele Sandrini <rasa@gmx.ch>
43 .SH EXAMPLES
44 After compilation, the following command generates a GI for pango:
45 .B vala-gen-introspect pango packages/pango
46 .TP
47 This can then be converted to a Vala API as follows:
48 .B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gi
49 .SH "SEE ALSO"
50 vapigen (1)