stklos-compile.1.in 1.91 KB
Newer Older
eg's avatar
eg committed
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
.\" -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH STKLOS-COMPILE 1 "version @VERSION@"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
stklos-compile \- Compiles a STklos file to byte-codes

.SH DESCRIPTION
The
.B stklos-compile
compiles a STklos file to byte-codes. For now, this command is very
poor, it should be extended in the future.

.SH OPTIONS
28
Here are the options available in the version @VERSION@ of
eg's avatar
eg committed
29 30
.B stklos.

31 32
.IP "--case-sensitive, -c"
Symbols are case sensitive
eg's avatar
eg committed
33 34 35
.IP "--output=<file>, -o <file>"
Output the compiled code in the given file instead of
.I a.out.
Erick Gallesio's avatar
Erick Gallesio committed
36 37
.IP "--C-code, -C"
Produce the byte-code in a C file instead of a ".ostk" file.
38

39 40
.IP "--evalute=<expr>, e <expr>"
Evaluate the Sexpr <expr> before starting compilation. This is useful,
41
for loading files which are needed for the compilation (e.g. files
42
defining new syntaxes).
eg's avatar
eg committed
43 44 45
.IP "--line-info, -l"
Generate line informations to ease debugging (incurs a small
performance penalty).
46
.IP "--show-instructions, -S"
47 48
Produce the VM instructions in the generated file. Actually,
it is probably only useful if you want to hack the VM.
49 50 51 52 53 54

.IP "--prepend-load-path=<dir>, -L <dir>"
Prepend the directory <dir> to the compiler loading path.
.IP "--append-load-path=<dir>"
Append the directory <dir> to the compiler loading path.

Erick Gallesio's avatar
Erick Gallesio committed
55 56
.IP "--no-time"
Do not display the compilation time
eg's avatar
eg committed
57 58 59 60 61 62
.IP "--help | -h | -?"
Show help.

.SH "SEE ALSO"
.BR stklos (1)
.BR stklos-config (1)