diff --git a/docs/g-ir-compiler.1 b/docs/g-ir-compiler.1 index c2197b44f..65c439bb8 100644 --- a/docs/g-ir-compiler.1 +++ b/docs/g-ir-compiler.1 @@ -1,41 +1,77 @@ -.TH "g-ir-compiler" 1 -.nh +.\" Man page generated from reStructuredText. +. +.TH G-IR-COMPILER 1 "" "" "" .SH NAME -g-ir-compiler \- typelib compiler. +g-ir-compiler \- Typelib compiler +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. .SH SYNOPSIS -.B g-ir-compiler -[OPTION...] GIRFILE +.sp +\fBg\-ir\-compiler\fP [OPTION...] GIRFILE .SH DESCRIPTION -g-ir-compiler converts one or more GIR files into one or more typelib. -The output will be written to standard output unless the --output -is specified. +.sp +g\-ir\-compiler converts one or more GIR files into one or more typelib. The +output will be written to standard output unless the \fB\-\-output\fP is +specified. .SH OPTIONS +.INDENT 0.0 .TP -.B \--help +.B \-\-help Show help options .TP -.B \--output=FILENAME +.BI \-\-output\fB= FILENAME Save the resulting output in FILENAME. .TP -.B \--verbose +.B \-\-verbose Show verbose messages .TP -.B \--debug +.B \-\-debug Show debug messages .TP -.B \--includedir=DIRECTORY +.BI \-\-includedir\fB= DIRECTORY Adds a directory which will be used to find includes inside the GIR format. .TP -.B \--module=MODULE +.BI \-\-module\fB= 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 ending shared library suffix. -.TP +.BI \-\-shared\-library\fB= FILENAME +Specifies the shared library where the symbols in the typelib can be +found. The name of the library should not contain the ending shared +library suffix. +.UNINDENT .SH BUGS -Report bugs at https://gitlab.gnome.org/GNOME/gobject\-introspection/issues. -.SH HOMEPAGE and CONTACT -http://live.gnome.org/GObjectIntrospection +.sp +Report bugs at \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP +.SH HOMEPAGE AND CONTACT +.sp +\fI\%http://live.gnome.org/GObjectIntrospection\fP .SH AUTHORS +.sp Mattias Clasen +.\" Generated by docutils manpage writer. +. diff --git a/docs/g-ir-generate.1 b/docs/g-ir-generate.1 index ffe4904a4..fb07de756 100644 --- a/docs/g-ir-generate.1 +++ b/docs/g-ir-generate.1 @@ -1,29 +1,63 @@ -.TH "g-ir-generate" 1 -.nh +.\" Man page generated from reStructuredText. +. +.TH G-IR-GENERATE 1 "" "" "" .SH NAME -g-ir-generate \- typelib generator +g-ir-generate \- Typelib generator +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. .SH SYNOPSIS -.B g-ir-generate -[OPTION...] FILES... +.sp +\fBg\-ir\-generate\fP [OPTION...] FILES... .SH DESCRIPTION -g-ir-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. +.sp +g\-ir\-generate is an GIR generator, using the repository API. It generates GIR +files from a raw typelib or in a shared library (\fB\-\-shlib\fP). The output will +be written to standard output unless the \fB\-\-output\fP is specified. .SH OPTIONS +.INDENT 0.0 .TP -.B \, --help +.B \-\-help Show help options .TP -.B \, --shlib=FILENAME +.BI \-\-shlib\fB= FILENAME The shared library to read the symbols from. .TP -.B \, --output=FILENAME +.BI \-\-output\fB= FILENAME Save the resulting output in FILENAME. -.TP +.UNINDENT .SH BUGS -Report bugs at https://gitlab.gnome.org/GNOME/gobject\-introspection/issues. -.SH HOMEPAGE and CONTACT -http://live.gnome.org/GObjectIntrospection +.sp +Report bugs at \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP +.SH HOMEPAGE AND CONTACT +.sp +\fI\%http://live.gnome.org/GObjectIntrospection\fP .SH AUTHORS +.sp Mattias Clasen +.\" Generated by docutils manpage writer. +. diff --git a/docs/website/tools/g-ir-compiler.rst b/docs/website/tools/g-ir-compiler.rst new file mode 100644 index 000000000..e87a9abd9 --- /dev/null +++ b/docs/website/tools/g-ir-compiler.rst @@ -0,0 +1,68 @@ +============= +g-ir-compiler +============= + +---------------- +Typelib compiler +---------------- + +:Manual section: 1 + + +SYNOPSIS +======== + +**g-ir-compiler** [OPTION...] GIRFILE + + +DESCRIPTION +=========== + +g-ir-compiler converts one or more GIR files into one or more typelib. The +output will be written to standard output unless the ``--output`` is +specified. + + +OPTIONS +======= + +--help + Show help options + +--output=FILENAME + Save the resulting output in FILENAME. + +--verbose + Show verbose messages + +--debug + Show debug messages + +--includedir=DIRECTORY + Adds a directory which will be used to find includes inside the GIR format. + +--module=MODULE + FIXME + +--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 ending shared + library suffix. + + +BUGS +==== + +Report bugs at https://gitlab.gnome.org/GNOME/gobject-introspection/issues + + +HOMEPAGE and CONTACT +==================== + +http://live.gnome.org/GObjectIntrospection + + +AUTHORS +======= + +Mattias Clasen diff --git a/docs/website/tools/g-ir-generate.rst b/docs/website/tools/g-ir-generate.rst new file mode 100644 index 000000000..662ec10b5 --- /dev/null +++ b/docs/website/tools/g-ir-generate.rst @@ -0,0 +1,54 @@ +============= +g-ir-generate +============= + +----------------- +Typelib generator +----------------- + +:Manual section: 1 + + +SYNOPSIS +======== + +**g-ir-generate** [OPTION...] FILES... + + +DESCRIPTION +=========== + +g-ir-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. + + +OPTIONS +======= + +--help + Show help options + +--shlib=FILENAME + The shared library to read the symbols from. + +--output=FILENAME + Save the resulting output in FILENAME. + + +BUGS +==== + +Report bugs at https://gitlab.gnome.org/GNOME/gobject-introspection/issues + + +HOMEPAGE and CONTACT +==================== + +http://live.gnome.org/GObjectIntrospection + + +AUTHORS +======= + +Mattias Clasen