docs/g-ir-doc-tool.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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.
.