summaryrefslogtreecommitdiff
path: root/docs/g-ir-compiler.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/g-ir-compiler.1')
-rw-r--r--docs/g-ir-compiler.151
1 files changed, 51 insertions, 0 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