Add man pages for the generator and compiler.

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.


svn path=/trunk/; revision=518

3 files changed, 81 insertions, 1 deletions

diff --git a/docs/g-ir-compiler.1 b/docs/g-ir-compiler.1
new file mode 100644
index 00000000..8d1b85d0
--- /dev/null
+++ b/docs/g-ir-compiler.1
@@ -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
diff --git a/docs/g-ir-generate.1 b/docs/g-ir-generate.1
new file mode 100644
index 00000000..7914cce3
--- /dev/null
+++ b/docs/g-ir-generate.1
@@ -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
diff --git a/docs/g-ir-scanner.1 b/docs/g-ir-scanner.1
index bab6cf0b..789e2c6f 100644
--- a/docs/g-ir-scanner.1
+++ b/docs/g-ir-scanner.1
@@ -32,7 +32,7 @@ correctly specified.
 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.