luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-14 00:06:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add man pages for the generator and compiler.

Browse Source 
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
This commit is contained in:
Johan Dahlin 2008-08-29 09:25:29 +00:00 committed by Simon McVittie
parent 64762fdef6
commit 3c65ea7a18
2 changed files with 80 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/g-ir-compiler.1 Normal file
View File

@ -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

29
docs/g-ir-generate.1 Normal file
View File

@ -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