diff options
Diffstat (limited to 'docs/g-ir-doc-tool.1')
| -rw-r--r-- | docs/g-ir-doc-tool.1 | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/g-ir-doc-tool.1 b/docs/g-ir-doc-tool.1 new file mode 100644 index 00000000..dabec8f2 --- /dev/null +++ b/docs/g-ir-doc-tool.1 @@ -0,0 +1,74 @@ +.\" Man page generated from reStructuredText. +. +.TH G-IR-DOC-TOOL 1 "" "" "" +.SH NAME +g-ir-doc-tool \- Documentation builder +. +.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 +.sp +\fBg\-ir\-doc\-tool\fP [OPTION...] GIRFILE +.SH DESCRIPTION +.sp +g\-ir\-doc\-tool builds library documentation directly from .gir files. The output +is adjusted according to which programming language you\(aqre generating docs for. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-\-help +Show help options +.TP +.BI \-\-output\fB= DIRECTORY +Save the resulting output in DIRECTORY. +.TP +.BI \-\-format\fB= FORMAT +Output format. One of devdocs, mallard or sections. +.TP +.BI \-\-language\fB= LANGUAGE +Output language. One of c, python, or gjs. +.TP +.BI \-\-add\-include\-path\fB= DIRECTORY +Adds a directory which will be used to find includes inside the GIR format. +.TP +.B \-\-version +Show program\(aqs version number and exit +.TP +.B \-\-write\-sections\-file +Backwards\-compatible equivalent to \-f sections. +.UNINDENT +.SH BUGS +.sp +Report bugs at \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP +.SH HOMEPAGE AND CONTACT +.sp +\fI\%https://gi.readthedocs.io/\fP +.SH AUTHORS +.sp +David King +.\" Generated by docutils manpage writer. +. |