From: Marc-Andre Lureau <malureau@src.gnome.org>
Date: Tue, 28 Aug 2007 15:13:08 +0000 (+0000)
Subject: doc: add vapigen and gidlgen manual pages
X-Git-Tag: VALA_0_1_3~36
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ef2f64dd558e6a97181775e38c870a8a3cd104ad;p=thirdparty%2Fvala.git

doc: add vapigen and gidlgen manual pages

svn path=/trunk/; revision=519
---

diff --git a/ChangeLog b/ChangeLog
index c492cc306..f7f55059b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-08-28  Marc-Andre Lureau  <marcandre.lureau@gmail.com>
+
+	* doc/Makefile.am, doc/gidlgen.1, doc/vapigen.1:
+	add manual pages for gidlgen and vapigen, written by Kumar Appaiah.
+	
 2007-08-28  Jürg Billeter  <j@bitron.ch>
 
 	* MAINTAINERS: update format as requested on desktop-devel
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 041d0c8e2..8345b9271 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,2 +1,2 @@
-dist_man_MANS=valac.1
+dist_man_MANS=valac.1 gidlgen.1 vapigen.1
 
diff --git a/doc/gidlgen.1 b/doc/gidlgen.1
new file mode 100644
index 000000000..7bdf967fe
--- /dev/null
+++ b/doc/gidlgen.1
@@ -0,0 +1,32 @@
+.TH gidlgen 1 "28 August 2007" "vala-0.1.2" "Vala"
+.IX gidlgen
+.SH NAME
+gidlgen \- generate a GAPI file for GObject and glib based packages
+.SH SYNOPSIS
+.B gidlgen \fISOURCE\fP \fIPKGBASE\fP
+
+.SH DESCRIPTION
+.B gidlgen
+is a utility which generates GAPI files from GObject and glib
+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. \fISOURCE\fP is the source package bundle (tarball)
+and \fIPKGBASE\fP specifies the base directory for that package.
+
+.SH EXAMPLES
+.TP
+After compilation, the following command generates a GAPI for pango:
+.B gidlgen pango-1.16.1.tar.bz2 packages/pango/pango
+
+.SH OPTIONS
+.TP
+This command currenly takes no command line options.
+.SH SEE ALSO
+.BR vapigen (1)
+
+.SH AUTHOR
+gidlgen 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).
diff --git a/doc/vapigen.1 b/doc/vapigen.1
new file mode 100644
index 000000000..beeb048dd
--- /dev/null
+++ b/doc/vapigen.1
@@ -0,0 +1,49 @@
+.TH vapigen 1 "28 August 2007" "vala-0.1.2" "Vala"
+.IX vapigen
+.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 GAPI files,
+which may be generated using the gidlgen(1) utility.
+
+.SH EXAMPLES
+.TP
+After compilation, the following command generates a GAPI for pango:
+.B gidlgen pango-1.16.1.tar.bz2 packages/pango/pango
+.TP
+This can then be converted to a Vala API as follows:
+.B vapigen --pkg cairo --vapidir . --library pango packages/pango/pango.gidl
+
+.SH OPTIONS
+.TP
+\-?, \-\-help
+Show help option
+.TP
+--vapidir=\fIDIRECTORY\fP
+Look for package bindings in \fIDIRECTORY\fP.
+.TP
+--pkg=\fIPACKAGE\fP
+Include binding for PACKAGE
+.TP
+--library=\fINAME\fP
+Specify library name as \fINAME\fP
+.TP
+\-d, \-\-directory=\fIDIRECTORY\fP
+Specify output directory as \fIDIRECTORY\fP
+.TP
+\-\-version
+Display version number and exit.
+
+.SH SEE ALSO
+.BR gidlgen (1)
+
+.SH AUTHOR
+vapigen 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).