Release 0.38.10
[vala-gnome.git] / doc / valac.1
blob75b3c9bed1d33404b7f1bfe1f41678148ba7f73f
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
2 .TH VALAC "1" "May 2018" "valac 0.38.10" "User Commands"
3 .SH NAME
4 valac \- compiler that translates Vala source code into C source and header files
5 .SH SYNOPSIS
6 .B valac
7 [\fIOPTION\fR]... [\fIFILE\fR]...
8 .SH DESCRIPTION
9 Vala  is  a  programming  language  that  aims  to  bring  modern
10 programming language features to GNOME developers without imposing any
11 additional  runtime requirements  and  without using  a different  ABI
12 compared to applications and libraries written in C.
13 .TP
14 valac, the Vala compiler, is a self-hosting compiler that translates
15 Vala source code into C source and header files. It uses the GObject
16 type system to create classes and interfaces declared in the Vala
17 source code.
18 .SS "Usage:"
19 .IP
20 valac [OPTION?] FILE... \- Vala Compiler
21 .SS "Help Options:"
22 .TP
23 \-?, \fB\-\-help\fR
24 Show help options
25 .SS "Application Options:"
26 .TP
27 \fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR...
28 Look for package bindings in DIRECTORY
29 .TP
30 \fB\-\-girdir\fR=\fI\,DIRECTORY\/\fR...
31 Look for .gir files in DIRECTORY
32 .TP
33 \fB\-\-metadatadir\fR=\fI\,DIRECTORY\/\fR...
34 Look for GIR .metadata files in DIRECTORY
35 .TP
36 \fB\-\-pkg\fR=\fI\,PACKAGE\/\fR...
37 Include binding for PACKAGE
38 .TP
39 \fB\-\-vapi\fR=\fI\,FILE\/\fR
40 Output VAPI file name
41 .TP
42 \fB\-\-library\fR=\fI\,NAME\/\fR
43 Library name
44 .TP
45 \fB\-\-shared\-library\fR=\fI\,NAME\/\fR
46 Shared library name used in generated gir
47 .TP
48 \fB\-\-gir\fR=\fI\,NAME\-VERSION\/\fR.gir
49 GObject\-Introspection repository file name
50 .TP
51 \fB\-b\fR, \fB\-\-basedir\fR=\fI\,DIRECTORY\/\fR
52 Base source directory
53 .TP
54 \fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
55 Change output directory from current working directory
56 .TP
57 \fB\-\-version\fR
58 Display version number
59 .TP
60 \fB\-\-api\-version\fR
61 Display API version number
62 .TP
63 \fB\-C\fR, \fB\-\-ccode\fR
64 Output C code
65 .TP
66 \fB\-H\fR, \fB\-\-header\fR=\fI\,FILE\/\fR
67 Output C header file
68 .TP
69 \fB\-\-use\-header\fR
70 Use C header file
71 .TP
72 \fB\-\-includedir\fR=\fI\,DIRECTORY\/\fR
73 Directory used to include the C header file
74 .TP
75 \fB\-h\fR, \fB\-\-internal\-header\fR=\fI\,FILE\/\fR
76 Output internal C header file
77 .TP
78 \fB\-\-internal\-vapi\fR=\fI\,FILE\/\fR
79 Output vapi with internal api
80 .TP
81 \fB\-\-fast\-vapi\fR
82 Output vapi without performing symbol resolution
83 .TP
84 \fB\-\-use\-fast\-vapi\fR
85 Use \fB\-\-fast\-vapi\fR output during this compile
86 .TP
87 \fB\-\-vapi\-comments\fR
88 Include comments in generated vapi
89 .TP
90 \fB\-\-deps\fR
91 Write make\-style dependency information to this file
92 .TP
93 \fB\-\-symbols\fR=\fI\,FILE\/\fR
94 Output symbols file
95 .TP
96 \fB\-c\fR, \fB\-\-compile\fR
97 Compile but do not link
98 .TP
99 \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
100 Place output in file FILE
102 \fB\-g\fR, \fB\-\-debug\fR
103 Produce debug information
105 \fB\-\-thread\fR
106 Enable multithreading support (DEPRECATED AND IGNORED)
108 \fB\-\-enable\-mem\-profiler\fR
109 Enable GLib memory profiler
111 \fB\-D\fR, \fB\-\-define\fR=\fI\,SYMBOL\/\fR...
112 Define SYMBOL
114 \fB\-\-main\fR=\fI\,SYMBOL\/\fR...
115 Use SYMBOL as entry point
117 \fB\-\-nostdpkg\fR
118 Do not include standard packages
120 \fB\-\-disable\-assert\fR
121 Disable assertions
123 \fB\-\-enable\-checking\fR
124 Enable additional run\-time checks
126 \fB\-\-enable\-deprecated\fR
127 Enable deprecated features
129 \fB\-\-hide\-internal\fR
130 Hide symbols marked as internal
132 \fB\-\-enable\-experimental\fR
133 Enable experimental features
135 \fB\-\-disable\-warnings\fR
136 Disable warnings
138 \fB\-\-fatal\-warnings\fR
139 Treat warnings as fatal
141 \fB\-\-disable\-since\-check\fR
142 Do not check whether used symbols exist in local packages
144 \fB\-\-enable\-experimental\-non\-null\fR
145 Enable experimental enhancements for non\-null types
147 \fB\-\-enable\-gobject\-tracing\fR
148 Enable GObject creation tracing
150 \fB\-\-cc\fR=\fI\,COMMAND\/\fR
151 Use COMMAND as C compiler command
153 \fB\-X\fR, \fB\-\-Xcc\fR=\fI\,OPTION\/\fR...
154 Pass OPTION to the C compiler
156 \fB\-\-pkg\-config\fR=\fI\,COMMAND\/\fR
157 Use COMMAND as pkg\-config command
159 \fB\-\-dump\-tree\fR=\fI\,FILE\/\fR
160 Write code tree to FILE
162 \fB\-\-save\-temps\fR
163 Keep temporary files
165 \fB\-\-profile\fR=\fI\,PROFILE\/\fR
166 Use the given profile instead of the default
168 \fB\-q\fR, \fB\-\-quiet\fR
169 Do not print messages to the console
171 \fB\-v\fR, \fB\-\-verbose\fR
172 Print additional messages to the console
174 \fB\-\-no\-color\fR
175 Disable colored output, alias for \fB\-\-color\fR=\fI\,never\/\fR
177 \fB\-\-color\fR=\fI\,WHEN\/\fR
178 Enable color output, options are 'always', 'never', or 'auto'
180 When no value is given \fIalways\fR is implied. When neither \fB--color\fR
181 or \fB--no-color\fR are declared then \fB--color\fR=\fIauto\fR is used where
182 output is colored when stderr is a terminal.
185 \fB\-\-target\-glib\fR=\fI\,MAJOR\/\fR.MINOR
186 Target version of glib for code generation
188 \fB\-\-gresources\fR=\fI\,FILE\/\fR...
189 XML of gresources
191 \fB\-\-gresourcesdir\fR=\fI\,DIRECTORY\/\fR...
192 Look for resources in DIRECTORY
194 \fB\-\-enable\-version\-header\fR
195 Write vala build version in generated files
197 \fB\-\-disable\-version\-header\fR
198 Do not write vala build version in generated files
199 .SH BUGS
200 https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
201 .SH "HOMEPAGE OR CONTACT"
202 https://wiki.gnome.org/Projects/Vala
203 .SH FEATURES
204 Interfaces, properties, signals, foreach, lambda expressions, type
205 inference for local variables, generics, non-null types, assisted memory
206 management, exception handling
207 .SH AUTHORS
208 J??rg Billeter, Raffaele Sandrini.