Release 0.41.92
[vala-gnome.git] / doc / valadoc.1
blobd7916582680e1dfb07f9f36dd25e26f605bb565c
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
2 .TH VALADOC "1" "August 2018" "valadoc 0.41.92" "User Commands"
3 .SH NAME
4 valadoc \- Vala Documentation Tool
5 .SH SYNOPSIS
6 .B valadoc
7 [\fIOPTION\fR]... \fIFILE\fR...
8 .SH DESCRIPTION
9 Valadoc is a documentation generator for generating API documentation
10 from Vala source code based on libvala.
11 .SS "Usage:"
12 .IP
13 valadoc [OPTION?] FILE... \- Vala Documentation Tool
14 .SS "Help Options:"
15 .TP
16 \fB\-h\fR, \fB\-\-help\fR
17 Show help options
18 .SS "Application Options:"
19 .TP
20 \fB\-o\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
21 Output directory
22 .TP
23 \fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR
24 Base source directory
25 .TP
26 \fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR...
27 Define SYMBOL
28 .TP
29 \fB\-\-profile\fR=\fI\,PROFILE\/\fR
30 Use the given profile instead of the default
31 .TP
32 \fB\-\-enable\-experimental\fR
33 Enable experimental features
34 .TP
35 \fB\-\-enable\-experimental\-non\-null\fR
36 Enable experimental enhancements for non\-null types
37 .TP
38 \fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
39 Look for GIR .metadata files in DIRECTORY
40 .TP
41 \fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
42 Look for .gir files in DIRECTORY
43 .TP
44 \fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
45 Look for package bindings in DIRECTORY
46 .TP
47 \fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
48 Include binding for PACKAGE
49 .TP
50 \fB\-\-driver\fR
51 Name of an driver or path to a custom driver
52 .TP
53 \fB\-\-importdir\fR=\fI\,DIRECTORY\/\fR...
54 Look for external documentation in DIRECTORY
55 .TP
56 \fB\-\-import\fR=\fI\,PACKAGE\/\fR...
57 Include binding for PACKAGE
58 .TP
59 \fB\-\-alternative\-resource\-dir\fR=\fI\,DIRECTORY\/\fR...
60 Alternative resource directories
61 .TP
62 \fB\-\-wiki\fR=\fI\,DIRECTORY\/\fR
63 Wiki directory
64 .TP
65 \fB\-\-deps\fR
66 Adds packages to the documentation
67 .TP
68 \fB\-\-doclet\fR=\fI\,PLUGIN\/\fR
69 Name of an included doclet or path to custom doclet
70 .TP
71 \fB\-X\fR, \fB\-\-doclet\-arg\fR=\fI\,ARG\/\fR
72 Pass arguments to the doclet
73 .TP
74 \fB\-\-no\-protected\fR
75 Removes protected elements from documentation
76 .TP
77 \fB\-\-internal\fR
78 Adds internal elements to documentation
79 .TP
80 \fB\-\-private\fR
81 Adds private elements to documentation
82 .TP
83 \fB\-\-use\-svg\-images\fR
84 Generate SVG image charts instead of PNG
85 .TP
86 \fB\-\-package\-name\fR=\fI\,NAME\/\fR
87 package name
88 .TP
89 \fB\-\-package\-version\fR=\fI\,VERSION\/\fR
90 package version
91 .TP
92 \fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir
93 GObject\-Introspection repository file name
94 .TP
95 \fB\-\-version\fR
96 Display version number
97 .TP
98 \fB\-\-force\fR
99 force
101 \fB\-\-verbose\fR
102 Show all warnings
104 \fB\-\-no\-color\fR
105 Disable colored output
107 \fB\-\-target\-glib\fR=\fI\,MAJOR\/\fR.MINOR
108 Target version of glib for code generation
109 .SH BUGS
110 https://gitlab.gnome.org/GNOME/vala/issues
111 .SH "HOMEPAGE OR CONTACT"
112 https://wiki.gnome.org/Projects/Valadoc
113 .SH AUTHORS
114 Florian Brosch