gobject-introspection r518 - in trunk: . docs

[johan svn gnome org]

Author: johan
Date: Fri Aug 29 09:25:29 2008
New Revision: 518
URL: http://svn.gnome.org/viewvc/gobject-introspection?rev=518&view=rev

Log:
2008-08-29  Johan Dahlin  <johan gnome org>

    * Makefile.am:
    * docs/g-ir-compiler.1:
    * docs/g-ir-generate.1:
    * docs/g-ir-scanner.1:
    Add man pages for the generator and compiler.



Added:
   trunk/docs/g-ir-compiler.1
   trunk/docs/g-ir-generate.1
Modified:
   trunk/ChangeLog
   trunk/Makefile.am
   trunk/docs/g-ir-scanner.1

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Fri Aug 29 09:25:29 2008
@@ -21,7 +21,10 @@
 SUBDIRS = girepository giscanner tools gir tests
 DIST_SUBDIRS = m4 $(SUBDIRS)
 
-man_MANS = docs/g-ir-scanner.1
+man_MANS = 			\
+	docs/g-ir-compiler.1	\
+	docs/g-ir-generate.1	\
+	docs/g-ir-scanner.1
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = gobject-introspection-1.0.pc

Added: trunk/docs/g-ir-compiler.1
==============================================================================
--- (empty file)
+++ trunk/docs/g-ir-compiler.1	Fri Aug 29 09:25:29 2008
@@ -0,0 +1,51 @@
+.TH "g-ir-compiler" 1
+.SH NAME
+g-ir-compiler \- typelib compiler.
+.SH SYNOPSIS
+.B g-ir-compiler
+[OPTION...] GIRFILE
+.SH DESCRIPTION
+g-ir-compiler converts one or more GIR files into one or more typelib. 
+It can either emit the raw typelib blob (default behavior) or C code
+(--code). The output will be written to standard output unless the --output 
+is specified.
+.SH OPTIONS
+.TP
+.B \---help
+Show help options
+.TP
+.B \, ---code
+Emit C code which is suitable for including in a shared library instead
+of a raw typelib.
+.TP
+.B \, ---output=FILENAME
+Save the resulting output in FILENAME.
+.TP
+.B \---verbose                       
+Show verbose messages
+.TP
+.B \---debug                       
+Show debug messages
+.TP
+.B \---no-init
+Do not include an initialization snippet to register the typelib in the
+respository. This can only be used if --code is also specified.
+.TP
+.B \---includedir=DIRECTORY
+Adds a directory which will be used to find includes inside the GIR format.
+.TP
+.B \---module=MODULE
+FIXME
+.TP
+.B \---shared-library=FILENAME
+Specifies the shared library where the symbols in the typelib can be found.
+The name of the library should not contain the leading lib prefix nor
+the ending shared library suffix.
+.TP
+.SH BUGS
+Report bugs at http://bugzilla.gnome.org/ in the glib product and
+introspection component.
+.SH HOMEPAGE and CONTACT
+http://live.gnome.org/GObjectIntrospection
+.SH AUTHORS
+Mattias Clasen

Added: trunk/docs/g-ir-generate.1
==============================================================================
--- (empty file)
+++ trunk/docs/g-ir-generate.1	Fri Aug 29 09:25:29 2008
@@ -0,0 +1,29 @@
+%.TH "g-ir-generate" 1
+.SH NAME
+g-ir-generate \- typelib generator
+.SH SYNOPSIS
+.B g-ir-generate
+[OPTION...] FILES...
+.SH DESCRIPTION
+g-idl-generate is an GIR generator, using the repository API. It generates
+GIR files from a raw typelib or in a shared library (--shlib).
+The output will be written to standard output unless the --output 
+is specified.
+.SH OPTIONS
+.TP
+.B \---help
+Show help options
+.TP
+.B \, ---shlib=FILENAME
+The shared library to read the symbols from.
+.TP
+.B \, ---output=FILENAME
+Save the resulting output in FILENAME.
+.TP
+.SH BUGS
+Report bugs at http://bugzilla.gnome.org/ in the glib product and
+introspection component.
+.SH HOMEPAGE and CONTACT
+http://live.gnome.org/GObjectIntrospection
+.SH AUTHORS
+Mattias Clasen

Modified: trunk/docs/g-ir-scanner.1
==============================================================================
--- trunk/docs/g-ir-scanner.1	(original)
+++ trunk/docs/g-ir-scanner.1	Fri Aug 29 09:25:29 2008
@@ -32,7 +32,7 @@
 Specifies a library that will be introspected. This means that the 
 *_get_type() functions in it will be called for GObject data types.
 The name of the library should not contain the leading lib prefix nor
-the ending shared library suffix. Eg: 
+the ending shared library suffix.
 .TP
 .B \-L, ---library-path=PATH
 Include this directory when searching for a library.