summaryrefslogtreecommitdiff
path: root/doc/vala-gen-introspect.1
diff options
context:
space:
mode:
authorRico Tzschichholz <ricotz@ubuntu.com>2017-03-05 18:00:40 +0100
committerRico Tzschichholz <ricotz@ubuntu.com>2017-03-06 17:09:50 +0100
commit0e7aecba5f60bcaf5028f6502fe6eb6ca615c724 (patch)
tree1b966d77f967415f7968b585f875497e254fcc71 /doc/vala-gen-introspect.1
parent379a7b14f7e5854b9d6fb791e3420030d6e2705b (diff)
downloadvala-0e7aecba5f60bcaf5028f6502fe6eb6ca615c724.tar.gz
docs: Generate and update manpages
Diffstat (limited to 'doc/vala-gen-introspect.1')
-rw-r--r--doc/vala-gen-introspect.152
1 files changed, 35 insertions, 17 deletions
diff --git a/doc/vala-gen-introspect.1 b/doc/vala-gen-introspect.1
index 68052d96a..6520c32ac 100644
--- a/doc/vala-gen-introspect.1
+++ b/doc/vala-gen-introspect.1
@@ -1,10 +1,9 @@
-.TH vala-gen-introspect 1 "26 October 2007" "vala-0.1.5" "Vala"
-.IX vala-gen-introspect
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
+.TH VALA-GEN-INTROSPECT "1" "March 2017" "vala-gen-introspect 0.35.6" "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
@@ -12,21 +11,40 @@ based packages. It can be used in combination with vapigen(1) to
generate an API for Vala, and allow it's 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.
-
-.SH EXAMPLES
+.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://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
+.SH "HOMEPAGE OR CONTACT"
+https://wiki.gnome.org/Projects/Vala
+.SH AUTHORS
+J??rg Billeter <j@bitron.ch>, Raffaele Sandrini <rasa@gmx.ch>
+.SH EXAMPLES
After compilation, the following command generates a GI for pango:
.B vala-gen-introspect pango packages/pango
-
-.SH OPTIONS
.TP
-This command currently takes no command line options.
-.SH SEE ALSO
-.BR vapigen (1)
-
-.SH AUTHOR
-vala-gen-introspect for Vala was written by Juerg Billeter <j@bitron.ch> and
-Raffaele Sandrini <rasa@gmx.ch>.
-.PP
-This manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>,
-for the Debian project (but may be used by others).
+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)