basque/basque.1 at master · nikolashn/basque · GitHub

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
75
.TH BASQUE 1
.SH NAME
basque \- the C Basque compiler
.SH SYNOPSIS
.B basque
[ options ] sourcefile [ options ]
.P
.B basque
[
.B \-h
|
.B \-v
]
.SH DESCRIPTION
Basque intends to be a general-purpose statically-typed procedural programming
language, similar to C, but with some improvements.
The C Basque compiler currently statically compiles for Linux x86_64 ELF, ahead
of time, and takes ASCII input.
.PP
When the C Basque compiler is invoked with an source file argument, it will
compile and assemble the source code into an executable file (there is no linker
or preprocessor).
.PP
A single dash
.B \-
can be used as the source file argument to read source code
from standard input.
.SH OPTIONS
.TP
.BR \-h ", " \-\-help
Write a list of options to standard output, then exit.
.TP
.BR \-v ", " \-\-version
Write the current version of the C Basque compiler to standard output, then exit.
.TP
.BR \-o " file"
Output compiled code into an executable file at the specified path. To write to
standard output, use a dash
.B \-
as the
.B file
argument. If this argument is not provided, and the input file name is
.BR filename.ba ","
the output file will be
.BR filename "."
Otherwise, the output file will be called
.BR out "."
.TP
.BR \-r ", " \-\-run
Run the compiled code after compilation. This will still generate an output file.
.TP
.BR \-s ", " \-\-silence\-warnings
Silence all compiler warnings.
.TP
.BR \-W ", " \-\-warnings-as-errors
Treat warnings as errors (terminate compilation on warnings).
.TP
.BR \-\-disable\-assertions
Disable compiling code for
.B assert
statements.
.TP
.BR \-\-include\-path " path"
Set paths for searching for included files. When an include statement is
processed, the C Basque compiler will first search in the same directory as the
file where the statement was written, then will search in include paths passed
to the compiler, in order from the start to the end of the string passed. Paths
are separated by colons.
.TP
.BR \-\-page\-size " size"
Set the size of memory pages in bytes. Setting the page size to 0 will leave it as default.
.SH COPYRIGHT
Copyright (C) 2021-2022 nikolashn.
.PP
The C Basque compiler is distributed under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.